BorgerBeskedService (Version 1 [UDV], 2024-4)
- Carsten Olsen
- Daniel Jensen
- Knud de Place (STAR)
BorgerBeskedService giver mulighed for at oprette en besked til borger via mail, sms, notifikation på Jobnet eller som en besked mellem to myndigheder. Sidstnævnte er en trådbaseret kommunikationsform, hvor to myndigheder (fx A-kasse og Jobcenter) kan kommunikere med borgeren i midten. De beskeder der er oprettet vil borgeren kunne se på Jobnet.
Metoder
- 1 CreateBorgerbesked (POST /v1/Borgerbesked)
- 2 CreateBorgerbeskedsvar (POST /v1/Borgerbesked/Svar/{borgerbeskedIdentifier})
- 3 Getbesked (GET /v1/BorgerBesked/{borgerbeskedIdentifier})
- 4 GetBesked (GET /v1/BorgerBesked)
- 5 GetBesked (GET /v1/BorgerBesked/Virksomhed/{cvrEnhedsid})
- 6 UpdateBesked (PUT /v1/BorgerBesked/{borgerbeskedIdentifier}/action/setstatus)
- 7 UpdateBeskedsvar (PUT /v1/BorgerBesked/Svar/{borgerbeskedIdentifier}/action/setstatus)
- 8 UpdateBesked (PUT /v1/BorgerBesked/{borgerbeskedIdentifier}/action/setmarkering)
- 9 Getbeskeddokument (GET /v1/BorgerBested/Dokument/{DocumentIdentifier})
CreateBorgerbesked (POST /v1/Borgerbesked)
(DFDG classic CreateMessage og JobnetCitizenMessageService (Version 2, 2016-4).CreateMessage)
Metoden bruges til at oprette og sende en besked via en kommunikationskanal. For kommunikationskanaler som SMS, mail og notifikationer på Jobnet, vil dette være at betragte som envejskommunikation til borger, uden mulighed for at borger kan returnere med svar.
Scope
borgerkommunikation.borgerbesked.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
createBorgerBeskedRequest | CreateBorgerBeskedRequestType |
| 1 |
|
- afsender (FromUser) | AfsenderDto
|
| 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen |
- - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- Personer (PersonCivilRegistrationIdentifierCollection) | 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 (PersonCivilRegistrationIdentifier) | 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 - * | CPR nummer |
- indholdstype (ContextTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231581 (Gl. DFDG CitizenMessageContextTypeIdentifierType) |
| 1 | Kodelisteværdi der fortæller hvilken kontekst meddelelsen skal oprettes under. Dette styrer eksempelvis hvor meddelelserne vises på jobnet |
- titel (Title) | string | Length: 0-200 | 0 - 1 | Titlen på meddelelsen. Denne skal ikke være sat i forbindelse med SMS - CitizenMessageChannelTypeIdentifierType 1. Max. længde 200 |
- tekst (Text) | string | Length: 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 (CitizenMessageResponseTypeIdentifier) |
| 1 | Angiver om borger eller sagsbehandler må besvare de beskeder, der indgår i tråden. | |
- afsendelseskanal (CitizenMessageChannelTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231605 (Gl. DFDG CitizenMessageChannelTypeIdentifierType) |
| 1 | Angiver om meddelelsen er en SMS, MAIL, notifikation på Jobnet eller en trådbaseret meddelelse. |
- modtagendeMyndighed (CitizenMessageRecipient) | string |
| 0 - 1 | Indeholder den myndighed der skal indgå i meddelelsen og stå som modtager. Er tom medmindre afsendelseskanal er Id 4 (Myndighed til Myndighed) |
- - organisationType (OrganisationTypeIdentifier) |
| 1 | Organisationstype. | |
- - organisationskode (OrganisationCode) | string |
| 1 | Organisationskode. |
- visIBeskedbakke (ShowInMessagebox) | boolean |
| 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke |
- beskedSynligFratidspunkt (MessageVisibleFromDate) | dateTime |
| 0 - 1 | Eventuel fremtidig visningsdato. Hvis udfyldt vises besked først når dato nås |
- beskedSynligTiltidspunkt (MessageVisibleToDate) | dateTime |
| 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 (MessageLatestReply) | dateTime |
| 0 - 1 | Eventuel dato for Svar senest |
- vigtighedsniveau (MessageImportantIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206755841 (Gl. DFDG MessageImportantIdentifierType) |
| 1 | Angiver hvor vigtig beskeden er for borger |
- vedhaeftetDokumenter (MessageDocumentCollection) | VedhaeftetDokumenterDto |
| 0 - * | Kollektion af vedhæftede dokumenter |
- - DocumentIdentifier (DocumentID) | guid | 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 (DocumentTitle) | string | Length: 1-260 | 1 | Titel på dokumentet. |
- - dokumentfiltype (DocumentExtensionIdentifier) | "STARFoundation".FiltypeCodeListHvor skal denne ligge? STAR.Foundation? (Gl. DFDG) DocumentExtensionIdentifierType |
| 1 | Dokumentfiltype. |
- - dokumentskema (DocumentSchemaTypeIdentifier) | Borgerkommunikation.DokumentSkemaTypeCodeList (Gl. DFDG DocumentSchemaTypeIdentifierType) |
| 0 - 1 | Hvilket XML skema der er til dokumentet hvis der er at typen XML |
- - dokumentdata (DocumentData) | base64Binary |
| 0 - 1 | Selve dokumentet. |
- arkivbesked (ArchiveMessage) | boolean |
| 1 | Om beskede er en arkiv besked |
- MessageTag | string |
| 0 - 1 | Multibeskeder, samme besked til mange borgere |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
createborgerbeskedResponce (CreateMessageResponse) | createborgerbeskedResponceDto |
| 1 |
|
- borgerbeskeder (ServiceReceiptCollection) | BorgerbeskederDto |
| 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 (ServiceReceipt) | BorgerbeskedDto |
| 1 - * | Servicekvittering |
- - - borgerbeskedIdentifier (MessageIdentifier) | guid | 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 identifikation af transaktion eller registrering |
- - - EventDate | dateTime |
| 1 | Tidspunkt for transaktionen eller registreing |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
4502 | Invalid organisationtype used | Invalid organisationtype used |
8044 | Education plan type is not allowed for citizen above age 30 | Education plan type is not allowed for citizen above age 30 |
8060 | Operation is not allowed when citizen has no active contact group | Operation is not allowed when citizen has no active contact group |
8062 | A valid combination of contact group and person category is required for publish | A valid combination of contact group and person category is required for publish |
8069 | Cancel subscription is not possible. Citizen does not have an education event subscription | Subscription not possible. Citizen does not have an education event subscription |
8074 | Education plan type is not allowed for citizen above age 25 | Education plan type is not allowed for citizen above age 25 |
8137 | The submitted CitizenMessageChannelTypeIdentifier is invalid | The submitted CitizenMessageChannelTypeIdentifier is invalid |
8138 | The submitted CitizenMessageContextTypeIdentifier is invalid | The submitted CitizenMessageContextTypeIdentifier is invalid |
8139 | The submitted CitizenMessageResponseTypeIdentifier is invalid | The submitted CitizenMessageResponseTypeIdentifier is invalid |
8140 | The submitted CitizenMessageStatusTypeIdentifier is invalid | The submitted CitizenMessageStatusTypeIdentifier is invalid |
8142 | Den angivet brugertype er invalid (The submitted UserTypeIdentifier is invalid) | Den angivet brugertype er invalid (The submitted UserTypeIdentifier is invalid) |
8143 | Den angivne tekst er over maksimun længde for kanalen The submitted text length exceeds maximum length for the channeltype | Den angivne tekst er over maksimun længde for kanalen The submitted text length exceeds maximum length for the channeltype |
8144 | The requested message could not be found | The requested message could not be found |
8149 | En modtager skal være angivet når kanal er 'MyndighedTilMyndighed' A receiver must be specified when channel is 'MyndighedTilMyndighed' | En modtager skal være angivet når kanal er 'MyndighedTilMyndighed' A receiver must be specified when channel is 'MyndighedTilMyndighed' |
8150 | Myndigheden skal være jobcenter eller a-kasse OrganisationType must be either A-kasse or Jobcenter | Myndigheden skal være jobcenter eller a-kasse OrganisationType must be either A-kasse or Jobcenter |
8151 | Organisationskode skal være angivet hvis kanal er 'MyndighedTilMyndighed' OrganisationCode must be specified when channel is 'MyndighedTilMyndighed' | Organisationskode skal være angivet hvis kanal er 'MyndighedTilMyndighed' OrganisationCode must be specified when channel is 'MyndighedTilMyndighed' |
8154 | Titel er ikke tilladt når kanal er SMS Title is not allowed when channelType is SMS | Titel er ikke tilladt når kanal er SMS Title is not allowed when channelType is SMS |
8155 | Borger er ikke medlem af den angivne a-kasse The citizen does not belong to the requested recipient Unemploymentfund | Borger er ikke medlem af den angivne a-kasse The citizen does not belong to the requested recipient Unemploymentfund |
8157 | Når kanalen ikke er 'MyndighedTilMyndighed' skal modtager være Null When ChannelType is not 'MyndighedTilMyndighed' then MessasgeRecipient must be null | Når kanalen ikke er 'MyndighedTilMyndighed' skal modtager være Null When ChannelType is not 'MyndighedTilMyndighed' then MessasgeRecipient must be null |
8200 | Max lenth of the title is 200 characters | Max lenth of the title is 200 characters |
8281 | Occupation key does not exist | Occupation key does not exist |
8282 | Occupation key is out of date | Occupation key is out of date |
8293 | En fejl er sket i forbindelse med vedhæftning af dokument An error occurred when creating an attachment. | En fejl er sket i forbindelse med vedhæftning af dokument An error occurred when creating an attachment. |
8306 | My plan does not exists | My plan does not exists |
8307 | The contact group when the MyPlan was created does not match citizens current contact group | The contact group when the MyPlan was created does not match citizens current contact group |
8309 | The MyPlan is already marked as valid | The MyPlan is already marked as valid |
8311 | Et default jobcenter eller a-kasse eksisterer ikke for personen A default jobcenter or a-kasse for the person does not exist | Et default jobcenter eller a-kasse eksisterer ikke for personen A default jobcenter or a-kasse for the person does not exist |
8312 | Titel er påkrævet eller er under minimumslængden for kanaltypen Title is required or the length does not meet the minimum length for the channel type | Titel er påkrævet eller er under minimumslængden for kanaltypen Title is required or the length does not meet the minimum length for the channel type |
8313 | Titel er ikke tilladt for denne kanaltype (hvad er forskellen til 8154 Title is not allowed for this channel type | Titel er ikke tilladt for denne kanaltype (hvad er forskellen til 8154???? Title is not allowed for this channel type |
9012 | Kan ikke oprette en besked for afsender Cannot create message for sender | Kan ikke oprette en besked for afsender Cannot create message for sender |
9013 | Den angivende beskedtype er ikke tilladt for afsender The submitted MessageType is not allowed for sender | Den angivende beskedtype er ikke tilladt for afsender The submitted MessageType is not allowed for sender |
9014 | Den angivende kanal er ikke tilladt for afsender The submitted ChannelType is not allowed for sender and messagetype | Den angivende kanal er ikke tilladt for afsender The submitted ChannelType is not allowed for sender and messagetype |
9015 | Den angivende ResponseType er ikke tillladt for beskedtype, afsender og kanal The submitted ResponseType is not allowed for messagetype, sender and channeltype | Den angivende ResponseType er ikke tillladt for beskedtype, afsender og kanal The submitted ResponseType is not allowed for messagetype, sender and channeltype |
9016 | Den angivende arkivbesked er ikke tillladt for beskedtype, afsender og kanal The submitted ArchiveMessage is not allowed for messagetype, sender and channeltype | Den angivende arkivbesked er ikke tillladt for beskedtype, afsender og kanal The submitted ArchiveMessage is not allowed for messagetype, sender and channeltype |
9017 | Den angivne visIBeskedbakke er ikke tilladt for denne beskedtype og afsendelseskanal The submitted ShowInMessageBox is not allowed for messagetype, sender and channeltype | Den angivne visIBeskedbakke er ikke tilladt for denne beskedtype og afsendelseskanal The submitted ShowInMessageBox is not allowed for messagetype, sender and channeltype |
9019 | Html er ikke tilladt Html text is not allowed | Html er ikke tilladt Html text is not allowed |
9020 | Synlig fra tidspunkt skal være mindst 1 dag i fremtiden Visible from date must atleast be one day in the future | Synlig fra tidspunkt skal være mindst 1 dag i fremtiden Visible from date must atleast be one day in the future |
9021 | Synlig til tidspunkt skal være mindst 1 dag i fremtiden og ikke mindre en synlig fra tidspunkt visible to date must be atleast one day in the future and no less than visible from date | Synlig til tidspunkt skal være mindst 1 dag i fremtiden og ikke mindre en synlig fra tidspunkt visible to date must be atleast one day in the future and no less than visible from date |
9022 | Seneste svarfrist skal være mindst 7 dage i fremtiden eller 7 dage efter Synlig fra tidspunkt Latest reply must be at least 7 days in the future or 7 days after visible from | Seneste svarfrist skal være mindst 7 dage i fremtiden eller 7 dage efter Synlig fra tidspunkt Latest reply must be at least 7 days in the future or 7 days after visible from |
9023 | Borger er ikke knyttet til oprettetAf eller eller modtager Citizen is not affiliated with CreatedByUser or MessageRecepient | Borger er ikke knyttet til oprettetAf eller eller modtager Citizen is not affiliated with CreatedByUser or MessageRecepient |
9024 | Borger er ikke medlem af oprettende a-kasse Citizen does not belong to creating Unemploymentfund | Citizen does not Borger er ikke medlem af oprettende a-kasse Citizen does not belong to creating Unemploymentfundto creating Unemploymentfund |
9100 | The submitted MessageImportantIdentifier is invalid | The submitted MessageImportantIdentifier is invalid |
9101 | The submitted DocumentExtensionTypeIdentifier is invalid | The submitted DocumentExtensionTypeIdentifier is invalid |
9102 | The submitted DocumentSchemaTypeIdentifier is invalid | The submitted DocumentSchemaTypeIdentifier is invalid |
9104 | Organisationtype skal være angivet når bruger er sagsbehandler Organisation code must be specified when usertype is sagsbehandler | Organisationtype skal være angivet når bruger er sagsbehandler Organisation code must be specified when usertype is sagsbehandler |
9105 | Minimum CVR nummer skal være angivet når bruger er virksomhed Minimum company cvr number must be specified when usertype is virksomhed | Minimum CVR nummer skal være angivet når bruger er virksomhed Minimum company cvr number must be specified when usertype is virksomhed |
9310 | Modtagende organisationskode kan ikke være et subjobcenter Recipient OrganisationCode cannot be subjobcenter OrganisationCode | Modtagende organisationskode kan ikke være et subjobcenter Recipient OrganisationCode cannot be subjobcenter OrganisationCode |
CreateBorgerbeskedsvar (POST /v1/Borgerbesked/Svar/{borgerbeskedIdentifier})
(Gl. DFDG CreateMessageReply og JobnetCitizenMessageService (Version 2, 2016-4).CreateMessageReply)
Metoden bruges som svar på en eksisterende meddelelse – dermed kan skabes beskedtråd.
Scope
borgerkommunikation.borgerbesked.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
createBorgerBeskedSvarRequest | CreateBorgerBeskedSvarRequestType |
| 1 |
|
- afsender (FromUser) | AfsenderDto
|
| 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen |
- - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- personnummer (PersonCivilRegistrationIdentifier) | 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 | CPR nummer på den borger beskeden omhandler. |
- borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 | Id på den besked svaret ønskes oprettet. |
- tekst (Text) | string | Length: 1-2000 | 1 | Indeholder den tekst svaret skal indeholde |
- vedhaeftetDokumenter (MessageDocumentCollection) | VedhaeftetDokumenterDto |
| 0 - * | Kollektion af vedhæftede dokumenter |
- - dokumentidentifier (DocumentID) | guid | 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 (DocumentTitle) | string | Length: 1-260 | 1 | Titel på dokumentet. |
- - dokumentfiltype (DocumentExtensionIdentifier) | "STARFoundation".FiltypeCodeListHvor skal denne ligge? STAR.Foundation? (Gl. DFDG) DocumentExtensionIdentifierType |
| 1 | Dokumentfiltype. |
- - dokumentskema (DocumentSchemaTypeIdentifier) | Borgerkommunikation.DokumentSkemaTypeCodeList (Gl. DFDG DocumentSchemaTypeIdentifierType) |
| 0 - 1 | Hvilket XML skema der er til dokumentet hvis der er at typen XML |
- - dokumentdata (DocumentData) | base64Binary |
| 0 - 1 | Selve dokumentet. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
borgerbeskedsvarResponse | BorgerbeskedsvarDto |
| 1 |
|
- ServiceReceipt | ServiceReceiptType |
| 1 | Indeholder GUID (CitizenMessageReplyIdentifier) for det nyoprettede svar. |
- - borgerbeskedsvarIdentifier (MessageIdentifier) | guid | 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 identifikation af svar |
- - EventDate | dateTime |
| 1 | Tidspunkt for transaktionen eller registreing |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
4013 | Unknown Client Destination | Unknown Client Destination |
4857 | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund |
6005 | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader |
8044 | Education plan type is not allowed for citizen above age 30 | Education plan type is not allowed for citizen above age 30 |
8060 | Operation is not allowed when citizen has no active contact group | Operation is not allowed when citizen has no active contact group |
8062 | A valid combination of contact group and person category is required for publish | A valid combination of contact group and person category is required for publish |
8069 | Cancel subscription is not possible. Citizen does not have an education event subscription | Subscription not possible. Citizen does not have an education event subscription |
8074 | Education plan type is not allowed for citizen above age 25 | Education plan type is not allowed for citizen above age 25 |
8143 | Den angivne tekst er over maksimun længde for kanalen The submitted text length exceeds maximum length for the channeltype | Den angivne tekst er over maksimun længde for kanalen The submitted text length exceeds maximum length for the channeltype |
8144 | The requested message could not be found | The requested message could not be found |
8145 | Beskeden har en svartype der ikke er er tillladt for besvarelser The message has an ResponseType which does not allow new replies. | Beskeden har en svartype der ikke er er tillladt for besvarelser The message has an ResponseType which does not allow new replies. |
8146 | Beskeden har en kanal der ikke tilllader for den nye besvarelse The message has an ChannelType which does not allow new replies. | Beskeden har en kanal der ikke tilllader for den nye besvarelse The message has an ChannelType which does not allow new replies. |
8147 | Beskeden har en status der ikke tilllader for den nye besvarelse The message has a StatusType which does not allow new replies. | Beskeden har en status der ikke tilllader for den nye besvarelse The message has a StatusType which does not allow new replies. |
8156 | Svaret skal være oprettes enten af modtagende eller sendende orginisation The reply has to be created by either the sending or receiving organization | Svaret skal være oprettes enten af modtagende eller sendende orginisation The reply has to be created by either the sending or receiving organization |
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 |
8293 | En fejl er sket i forbindelse med vedhæftning af dokument An error occurred when creating an attachment. | En fejl er sket i forbindelse med vedhæftning af dokument An error occurred when creating an attachment. |
9006 | The specified MarkMessageIdentifier is not valid | The specified MarkMessageIdentifier is not valid |
9007 | An archived message cannot be marked | An archived message cannot be marked |
9104 | Organisationtype skal være angivet når bruger er sagsbehandler Organisation code must be specified when usertype is sagsbehandler | Organisationtype skal være angivet når bruger er sagsbehandler Organisation code must be specified when usertype is sagsbehandler |
9105 | Minimum CVR nummer skal være angivet når bruger er virksomhed Minimum company cvr number must be specified when usertype is virksomhed | Minimum CVR nummer skal være angivet når bruger er virksomhed Minimum company cvr number must be specified when usertype is virksomhed |
9114 | Beskeden har en svartype der ikke er tilladt for virksomheder The message has an ResponseType which does not allow reply from Company | The message has an Beskeden har en svartype der ikke er tilladt for virksomheder The message has an ResponseType which does not allow reply from Companywhich does not allow reply from Company |
9115 | Det er kun opretter og modtager der må svar på beskeder You are not allowed to reply on this message since you are not MessageCreator or MessageRecipient (Hvad er forskellen til 8156??) | Det er kun opretter og modtager der må svar på beskeder You are not allowed to reply on this message since you are not MessageCreator or MessageRecipient |
9116 | Seneste tidspunkt for besvarelse er overskredet Latest reply date for message has expired | Seneste tidspunkt for besvarelse er overskredet Latest reply date for message has expired |
Getbesked (GET /v1/BorgerBesked/{borgerbeskedIdentifier})
(Gl. DFDG GetMessage og JobnetCitizenMessageService (Version 2, 2016-4).GetMessage)
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 |
|---|---|---|---|---|
getborgerbeskedRequest | getborgerbeskedRequestDto |
| 1 |
|
- x-civilRegistrationIdentifier [Header] (PersonCivilRegistrationIdentifier) | 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 | CPR nummer på den borgen beskeden omhandler. |
- borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 | Id på den besked der ønskes hentet. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getborgerbeskedResponse | GetborgerbeskedResponseDto |
| 1 |
|
- borgerbesked (CitizenMessage) | borgerbeskedDto |
| 1 |
|
- - borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 (ContextTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231581 (Gl. DFDG CitizenMessageContextTypeIdentifierType) |
| 1 | Kodelisteværdi der fortæller den kontekst meddelelsen er blevet oprettet under |
- - afsender (CreatedByUser) | CitizenMessageUserType |
| 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen |
- - - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPRPPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- - titel (Title) | string |
| 0 - 1 | Titlen på dialogen |
- - tekst (Text) | string |
| 1 | Tekst dialogen skal indeholde |
- - modtagendeMyndighed (MessageRecipient) | string |
| 0 - 1 | Indeholder den myndighed der skal indgå i meddelelsen og stå som modtager. |
- - - organisationType (OrganisationTypeIdentifier) |
| 1 | Organisationstype. | |
- - - organisationskode (OrganisationCode) | string |
| 1 | Organisationskode. |
- - afsendelseskanal (CitizenMessageChannelTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231605 (Gl. DFDG CitizenMessageChannelTypeIdentifierType) |
| 1 | Angiver om meddelelsen er en SMS, MAIL, notifikation på Jobnet eller en trådbaseret meddelelse |
- - besvarelsestype (CitizenMessageResponseTypeIdentifier) |
| 1 | Angiver om borger eller sagsbehandler må besvare på de beskeder der indgår i tråden. | |
- - borgerbeskedsvar (MessageReplyCollection) | BeskedsvarDto |
| 0 - 1 | Indeholder en liste over alle de retursvar der er oprettet til denne dialog |
- - - beskedsvar (CitizenMessageReply) | BeskedsvarDto |
| 0 - * | Svar |
- - - - borgerbeskedsvarIdentifier (MessageReplyIdentifier) | guid | 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 | Id på beskedsvar. |
- - - - afsender (CreatedByUser) | CitizenMessageUserType |
| 1 | Indeholder informationer om den person der har svaret på beskeden |
- - - - - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - - - - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - - - - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - - - - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - - - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - - - - pNummer (ProductionUnitIdentifier) | string | Length: 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 CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - - - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - - - - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- - - - tekst (Text) | string |
| 1 | Tekst retursvar indeholder |
- - - - oprettelsestidspunkt (CreatedDate) | dateTime |
| 1 | Dato og tid for hvornår svar er blevet oprettet |
- - - - beskedstatus (StatusTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208885761 (Gl DFDG CitizenMessageStatusTypeIdentifierType) |
| 1 | Kodeliste der indikerer om svar fejloprettet |
- - - - vedhaeftetDokumenter (MessageDocumentCollection) | VedhaeftetDokumenterDto |
| 0 - 1 | Kollektion af vedhæftede dokumenter |
- - - - - vedhaeftetDokument (MessageDocument) | VvedhaeftetDokumentDto |
| 0 - * |
|
- - - - - - dokumentidentifier (DocumentID) | guid | 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 (DocumentTitle) | string | Length: 1-260 | 1 | Titel på dokumentet. |
- - - - - - dokumentfiltype (DocumentExtensionIdentifier) | "STARFoundation".FiltypeCodeListHvor skal denne ligge? STAR.Foundation? (Gl. DFDG) DocumentExtensionIdentifierType |
| 1 | Dokumentfiltype. |
- - - - - - dokumentskema (DocumentSchemaTypeIdentifier) | Borgerkommunikation.DokumentSkemaTypeCodeList (Gl. DFDG DocumentSchemaTypeIdentifierType) |
| 0 - 1 | Hvilket XML skema der er til dokumentet hvis der er at typen XML |
- - - - - - dokumentdata (DocumentData) | base64Binary |
| 0 - 1 | Selve dokumentet indgår aldrig her, men kan hentes med metoden GetCitizenMessageDocument. |
- - - - beskedstatusmarkeringer (CitizenMessageMarkCollection) | BeskedstatusmarkeringerDto |
| 1 | Kollektion af markeringer for visning og læsning |
- - - - - beskedstatusmarkering (CitizenMessageMark) | BeskedstatusmarkeringDto |
| 0 - * | Marking af beskedes visning og / eller læsningsstatus |
- - - - - - statusmarkering (MarkMessageIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208164902 (Gl. DFDG MarkMessageIdentifierType) |
| 1 | Benyttes til at angive attributter i forbindelse med visning, læsning m.v. for en besked. |
- - - - - - haendelsestidspunkt (EventDate) | dateTime |
| 1 | Dato for hvornår handlingen blev udført. |
- - - - berigtigelseskommentar (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
- - beskedstatus (CitizenStatusTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208885761 (Gl DFDG CitizenMessageStatusTypeIdentifierType) |
| 1 | Kodeliste der indikerer om dialogen er aktiv, lukket, fejloprettet |
- - oprettelsestidspunkt (CreatedDate) | dateTime |
| 1 | Dato og tid for hvornår dialogen er blevet oprettet |
- - visIBeskedbakke (ShowInMessagebox) | boolean |
| 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke |
- - beskedSynligFratidspunkt (MessageVisibleFromDate) | dateTime |
| 0 - 1 | Eventuel fremtidig visningsdato. Hvis udfyldt vises besked først når dato nås |
- - beskedSynligTiltidspunkt (MessageVisibleToDate)(MessageVisibleFromDate) | dateTime |
| 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 (MessageLatestReply) | dateTime |
| 0 - 1 | Eventuel dato for Svar senest |
- - vigtighedsniveau (MessageImportantIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206755841 (Gl. DFDG MessageImportantIdentifierType) |
| 1 | Angiver hvor vigtig beskeden er for borger |
- - vedhaeftetDokumenter (MessageDocumentCollection) | VedhaeftetDokumenterDto |
| 0 - 1 | Kollektion af vedhæftede dokumenter |
- - - vedhaeftetDokument (MessageDocument) | VvedhaeftetDokumentDto |
| 0 - * |
|
- - - - dokumentidentifier (DocumentID) | guid | 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 (DocumentTitle) | string | Length: 1-260 | 1 | Titel på dokumentet. |
- - - - dokumentfiltype (DocumentExtensionIdentifier) | "STARFoundation".FiltypeCodeListHvor skal denne ligge? STAR.Foundation? (Gl. DFDG) DocumentExtensionIdentifierType |
| 1 | Dokumentfiltype. |
- - - - dokumentskema (DocumentSchemaTypeIdentifier) | Borgerkommunikation.DokumentSkemaTypeCodeList (Gl. DFDG DocumentSchemaTypeIdentifierType) |
| 0 - 1 | Hvilket XML skema der er til dokumentet hvis der er at typen XML |
- - - - dokumentdata (DocumentData) | base64Binary |
| 0 - 1 | Selve dokumentet indgår aldrig her, men kan hentes med metoden GetCitizenMessageDocument. |
- - beskedstatusmarkeringer (CitizenMessageMarkCollection) | BeskedstatusmarkeringerDto |
| 1 | Kollektion af markeringer for visning og læsning |
- - - beskedstatusmarkering (CitizenMessageMark) | BeskedstatusmarkeringDto |
| 0 - * | Marking af beskedes visning og / eller læsningsstatus |
- - - - statusmarkering (MarkMessageIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208164902 (Gl. DFDG MarkMessageIdentifierType) |
| 1 | Benyttes til at angive attributter i forbindelse med visning, læsning m.v. for en besked. |
- - - - haendelsestidspunkt (EventDate) | dateTime |
| 1 | Dato for hvornår handlingen blev udført. |
- - beskedTags (CitizenMessageTagCollection) | CitizenMessageTagCollectionType |
| 1 | Multibeskeder, samme besked til mange borgere |
- - - beskedTag (CitizenMessageTag) | CitizenMessageTagType |
| 0 - * | Multibeskeder, samme besked til mange borgere |
- - - - oprettetAf (CreatedByUser) | CitizenMessageUserType |
| 1 | Opretter |
- - - - - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - - - - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - - - - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - - - - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - - - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - - - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - - - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - - - - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- - - - beskedTag (CitizenMessageTag) | string |
| 1 | Multibeskeder, samme besked til mange borgere |
- - - - haendelsestidspunkt (EventDate) | dateTime |
| 1 |
|
- - berigtigelseskommentar (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4857 | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund |
6005 | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader |
8144 | The requested message could not be found | The requested message could not be found |
GetBesked (GET /v1/BorgerBesked)
(Gl DFDG GetMessages og JobnetCitizenMessageService (Version 2, 2016-4).GetMessagesCV)
Metoden bruges til at hente alle de beskeder der er oprettet for en borger. Af performancemæssige hensyn giver servicemetoden mulighed for kun at returnere hovedbeskeden uden de underliggende svar.
Scope
borgerkommunikation.borgerbesked.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getBeskedRequest (GetMessagesRequest) | GetBeskedRequestDto |
| 1 |
|
- x-civilRegistrationIdentifier [Header] (PersonCivilRegistrationIdentifier) |
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 | CPR nummer på den borgen beskeden omhandler. |
- indholdstype [Query] (ContextTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231581 (Gl. DFDG CitizenMessageContextTypeIdentifierType) |
| 0 - 1 | Kan benyttes til at filtrere beskederne på kontekst. |
- svarSkalMedtages [Query] (IncludeReplies) | boolean |
| 1 | Kan sættes til true hvis svar på beskeder ønskes. |
- ulaeste [Query] (UnreadOnly) | boolean |
| 1 | Kan sættes til true hvis kun ulæste beskeder ønskes |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getBeskedResponse (GetMessagesResponse) | GetBeskedResponseDto |
| 1 |
|
- beskeder (CitizenMessageCollection) | BeskederDto |
| 0 - 1 | Liste af beskeder |
- - besked (CitizenMessage) | BeskedDto |
| 0 - * | Besked |
- - - borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 (ContextTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231581 (Gl. DFDG CitizenMessageContextTypeIdentifierType) |
| 1 | Kodelisteværdi der fortæller den kontekst meddelelsen er blevet oprettet under |
- - - afsender (CreatedByUser) | CitizenMessageUserType |
| 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen |
- - - - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - - - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - - - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - - - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - - - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- - - titel (Title) | string |
| 0 - 1 | Titlen på dialogen |
- - - tekst (Text) | string |
| 1 | Tekst dialogen skal indeholde |
- - - modtagendeMyndighed (MessageRecipient) | string |
| 0 - 1 | Indeholder den myndighed der skal indgå i meddelelsen og stå som modtager. |
- - - - organisationType (OrganisationTypeIdentifier) |
| 1 | Organisationstype. | |
- - - - organisationskode (OrganisationCode) | string |
| 1 | Organisationskode. |
- - - afsendelseskanal (CitizenMessageChannelTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231605 (Gl. DFDG CitizenMessageChannelTypeIdentifierType) |
| 1 | Angiver om meddelelsen er en SMS, MAIL, notifikation på Jobnet eller en trådbaseret meddelelse |
- - - besvarelsestype (CitizenMessageResponseTypeIdentifier) |
| 1 | Angiver om borger eller sagsbehandler må besvare på de beskeder der indgår i tråden. | |
- - - borgerbeskedsvar (MessageReplyCollection) | BeskedsvarDto |
| 0 - 1 | Indeholder en liste over alle de retursvar der er oprettet til denne dialog |
- - - - beskedTag (CitizenMessageTag) | BeskedsvarDto |
| 0 - * | Multibeskeder, samme besked til mange borgere |
- - - - - borgerbeskedsvarIdentifier (MessageReplyIdentifier) | guid | 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 |
|
- - - - - afsender (CreatedByUser) | CitizenMessageUserType |
| 1 | Indeholder informationer om den person der har svaret på beskeden |
- - - - - - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - - - - - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - - - - - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - - - - - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - - - - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - - - - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - - - - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - - - - - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- - - - - tekst (Text) | string | Length: 1-2000 | 1 | Tekst retursvar indeholder |
- - - - - oprettelsestidspunkt (CreatedDate) | dateTime |
| 1 | Dato og tid for hvornår svar er blevet oprettet |
- - - - - beskedstatus (StatusTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208885761 (Gl DFDG CitizenMessageStatusTypeIdentifierType) |
| 1 | Kodeliste der indikerer om svar er aktiv eller fejloprettet |
- - - - - vedhaeftetDokumenter (MessageDocumentCollection) | VedhaeftetDokumenterDto |
| 0 - 1 | Kollektion af vedhæftede dokumenter |
- - - - - - vedhaeftetDokument (MessageDocument) | VvedhaeftetDokumentDto |
| 0 - * |
|
- - - - - - - dokumentidentifier (DocumentID) | guid | 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 (DocumentTitle) | string | Length: 1-260 | 1 | Titel på dokumentet. |
- - - - - - - dokumentfiltype (DocumentExtensionIdentifier) | "STARFoundation".FiltypeCodeListHvor skal denne ligge? STAR.Foundation? (Gl. DFDG) DocumentExtensionIdentifierType |
| 1 | Dokumentfiltype. |
- - - - - - - dokumentskema (DocumentSchemaTypeIdentifier) | Borgerkommunikation.DokumentSkemaTypeCodeList (Gl. DFDG DocumentSchemaTypeIdentifierType) |
| 0 - 1 | Hvilket XML skema der er til dokumentet hvis der er at typen XML |
- - - - - - - dokumentdata (DocumentData) | base64Binary |
| 0 - 1 | Selve dokumentet indgår aldrig her, men kan hentes med metoden GetCitizenMessageDocument. |
- - - - - beskedstatusmarkeringer (CitizenMessageMarkCollection) | BeskedstatusmarkeringerDto |
| 1 | Kollektion af markeringer for visning og læsning |
- - - - - - beskedstatusmarkering (CitizenMessageMark) | BeskedstatusmarkeringDto |
| 0 - * | Marking af beskedes visning og / eller læsningsstatus |
- - - - - - - statusmarkering (MarkMessageIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208164902 (Gl. DFDG MarkMessageIdentifierType) |
| 1 | Benyttes til at angive attributter i forbindelse med visning, læsning m.v. for en besked. |
- - - - - - - haendelsestidspunkt (EventDate) | dateTime |
| 1 | Dato for hvornår handlingen blev udført. |
- - - - - berigtigelseskommentar (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
- - - beskedstatus (CitizenStatusTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208885761 (Gl DFDG CitizenMessageStatusTypeIdentifierType) |
| 1 | Kodeliste der indikerer om dialogen er aktiv, lukket, fejloprettet |
- - - oprettelsestidspunkt (CreatedDate) | dateTime |
| 1 | Dato og tid for hvornår dialogen er blevet oprettet |
- - - visIBeskedbakke (ShowInMessagebox) | boolean |
| 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke |
- - - beskedSynligFratidspunkt (MessageVisibleFromDate) | dateTime |
| 0 - 1 | Eventuel fremtidig visningsdato. Hvis udfyldt vises besked først når dato nås |
- - - beskedSynligTiltidspunkt (MessageVisibleToDate) | dateTime |
| 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 (MessageLatestReply) | dateTime |
| 0 - 1 | Eventuel dato for Svar senest |
- - - vigtighedsniveau (MessageImportantIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206755841 (Gl. DFDG MessageImportantIdentifierType) |
| 1 | Angiver hvor vigtig beskeden er for borger |
- - - vedhaeftetDokumenter (MessageDocumentCollection) | VedhaeftetDokumenterDto |
| 0 - 1 | Kollektion af vedhæftede dokumenter |
- - - - vedhaeftetDokument (MessageDocument) | VedhaeftetDokumentDto |
| 0 - * |
|
- - - - - dokumentidentifier (DocumentID) | guid | 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 (DocumentTitle) | string | Length: 1-260 | 1 | Titel på dokumentet. |
- - - - - dokumentfiltype (DocumentExtensionIdentifier) | "STARFoundation".FiltypeCodeListHvor skal denne ligge? STAR.Foundation? (Gl. DFDG) DocumentExtensionIdentifierType |
| 1 | Dokumentfiltype. |
- - - - - dokumentskema (DocumentSchemaTypeIdentifier) | Borgerkommunikation.DokumentSkemaTypeCodeList (Gl. DFDG DocumentSchemaTypeIdentifierType) |
| 0 - 1 | Hvilket XML skema der er til dokumentet hvis der er at typen XML |
- - - - - dokumentdata (DocumentData) | base64Binary |
| 0 - 1 | Selve dokumentet indgår aldrig her, men kan hentes med metoden GetCitizenMessageDocument. |
- - - beskedstatusmarkeringer (CitizenMessageMarkCollection) | BeskedstatusmarkeringerDto |
| 1 | Kollektion af markeringer for visning og læsning |
- - - - beskedstatusmarkering (CitizenMessageMark) | BeskedstatusmarkeringDto |
| 0 - * | Marking af beskedes visning og / eller læsningsstatus |
- - - - - statusmarkering (MarkMessageIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208164902 (Gl. DFDG MarkMessageIdentifierType) |
| 1 | Benyttes til at angive attributter i forbindelse med visning, læsning m.v. for en besked. |
- - - - - haendelsestidspunkt (EventDate) | dateTime |
| 1 | Dato for hvornår handlingen blev udført. |
- - - beskedTags (CitizenMessageTagCollection) | CitizenMessageTagCollectionType |
| 1 | Multibeskeder, samme besked til mange borgere |
- - - - beskedTag (CitizenMessageTag) | CitizenMessageTagType |
| 0 - * | Multibeskeder, samme besked til mange borgere |
- - - - - oprettetAf (CreatedByUser) | CitizenMessageUserType |
| 1 | Opretter |
- - - - - - brugertype (UserTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4205182978 (Gl. DFDG CitizenMessageUserTypeIdentifierType) |
| 1 | Angiver om user enten er borger eller sagsbehandler |
- - - - - - brugerIdentifier (UserIdentifier) | string |
| 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CPR nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID |
- - - - - - navn (FullName) | string |
| 1 | Sagsbehandlers eller borgerens fulde navn . |
- - - - - - virksomhed (Company) | VirksomhedDto |
| 0 - 1 | Angiver virksomhedsinformation |
- - - - - - - CompanyIdentifier | CompanyIdentifierType |
| 1 | Angiver CVR og P-nummer |
- - - - - - - pNummer (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- - - - - - - virksomhedKontaktIdentifier (CompanyContactIdentifier) | guid | 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 (OrganisationTypeIdentifier) |
| 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse | |
- - - - - - organisationskode (OrganisationCode) | string |
| 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse. |
- - - - - beskedTag (CitizenMessageTag) | string |
| 1 | Multibeskeder, samme besked til mange borgere |
- - - - - haendelsestidspunkt (EventDate) | dateTime |
| 1 |
|
- - - berigtigelseskommentar (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4857 | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund |
6005 | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader |
8138 | The submitted CitizenMessageContextTypeIdentifier is invalid | The submitted CitizenMessageContextTypeIdentifier is invalid |
GetBesked (GET /v1/BorgerBesked/Virksomhed/{cvrEnhedsid})
(Gl DFDG GetMessages og JobnetCitizenMessageService (Version 2, 2016-4).GetMessagesCompany)toden bruges til at hente alle de beskeder der er oprettet for en borger. Af performancemæssige hensyn giver servicemetoden mulighed for kun at returnere hovedbeskeden uden de underliggende svar.
Scope
borgerkommunikation.borgerbesked.virksomhed.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getBeskedRequest (GetMessagesRequest) | GetBeskedRequestDto |
| 1 |
|
- indholdstype [Query] (ContextTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4206231581 (Gl. DFDG CitizenMessageContextTypeIdentifierType) |
| 0 - 1 | Kan benyttes til at filtrere beskederne på kontekst. |
- svarSkalMedtages [Query] (IncludeReplies) | boolean |
| 1 | Kan sættes til true hvis svar på beskeder ønskes. |
- ulaeste [Query] (UnreadOnly) | boolean |
| 1 | Kan sættes til true hvis kun ulæste beskeder ønskes |
- pNummer [Query] (ProductionUnitIdentifier) | string | Length: 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 (CVRnumberIdentifier) | string | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
- virksomhedKontaktIdentifier [Query] (CompanyContactIdentifier) | guid | 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) |
Output
Se GetBeskeder (GET /v1/Beskeder)
UpdateBesked (PUT /v1/BorgerBesked/{borgerbeskedIdentifier}/action/setstatus)
(Gl. DFDG SetMessageStatus og JobnetCitizenMessageService (Version 2, 2016-4).)
Metoden bruges til at angive om en besked er afsluttet eller fejlagtigt oprettet. Denne servicemetode kan kun anvendes hvis afsendelseskanal er Id 3 “Jobnet beskedbakke” eller Id 4 "Myndighed til Myndighed"
Scope
borgerkommunikation.borgerbesked.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
SetMessageStatusRequest | SetMessageStatusRequestType |
| 1 |
|
- x-civilRegistrationIdentifier [Header] (PersonCivilRegistrationIdentifier) | 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 | CPR nummer på den borgen beskeden omhandler. |
- borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 | Id på den besked der ønskes ændret status. |
- CitizenMessageStatusTypeIdentifier | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208885761 (Gl DFDG CitizenMessageStatusTypeIdentifierType)CitizenMessageStatusTypeIdentifierType |
| 1 | Kodeliste der indikerer om dialogen er aktiv, lukket, fejloprettet |
- berigtigelseskommentar (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Kommentar til fejloprettet |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
Tom |
|
|
|
|
SetMessageStatusResponse | SetMessageStatusResponseType |
| 1 |
|
- ServiceReceipt | ServiceReceiptType |
| 1 | Servicekvittering |
- - borgerbeskedIdentifier (MessageIdentifier) | guid | 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 identifikation af transaktion eller registrering |
- - EventDate | dateTime |
| 1 | Tidspunkt for transaktionen eller registreing |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
4013 | Unknown Client Destination | Unknown Client Destination |
4857 | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund |
6005 | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader |
8044 | Education plan type is not allowed for citizen above age 30 | Education plan type is not allowed for citizen above age 30 |
8060 | Operation is not allowed when citizen has no active contact group | Operation is not allowed when citizen has no active contact group |
8062 | A valid combination of contact group and person category is required for publish | A valid combination of contact group and person category is required for publish |
8069 | Cancel subscription is not possible. Citizen does not have an education event subscription | Subscription not possible. Citizen does not have an education event subscription |
8074 | Education plan type is not allowed for citizen above age 25 | Education plan type is not allowed for citizen above age 25 |
8140 | The submitted CitizenMessageStatusTypeIdentifier is invalid | The submitted CitizenMessageStatusTypeIdentifier is invalid |
8144 | The requested message could not be found | The requested message could not be found |
8156 | Svaret skal være oprettes enten af modtagende eller sendende orginisation The reply has to be created by either the sending or receiving organization | Svaret skal være oprettes enten af modtagende eller sendende orginisation The reply has to be created by either the sending or receiving organization |
8160 | Status kan kun skiftes, hvis status er Aktiv | Status kan kun skiftes, hvis status er Aktiv |
8196 | Det er kun muligt at ændre status hvis beskeden er M2M eller jobnet beskedbakke It is only possible to change status if the message channel is M2M or jobnet beskedbakke | Det er kun muligt at ændre status hvis beskeden er M2M eller jobnet beskedbakke It is only possible to change status if the message channel is M2M or jobnet beskedbakke |
8300 | Begrigtigelseskommentar der påkrævet med status Fejloprette Correction comment required for messages with status fejloprettet | Begrigtigelseskommentar der påkrævet med status Fejloprette Correction comment required for messages with status fejloprettet |
UpdateBeskedsvar (PUT /v1/BorgerBesked/Svar/{borgerbeskedIdentifier}/action/setstatus)
(Gl. DFDG SetMessageReplyStatus og JobnetCitizenMessageService (Version 2, 2016-4).SetMessageReplyStatus)
Denne metode anvendes til at markere at et svar er blevet fejlagtigt oprettet.
Scope
borgerkommunikation.borgerbesked.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
SetMessageReplyStatusRequest | SetMessageReplyStatusRequestType |
| 1 |
|
- x-civilRegistrationIdentifier [Header] (PersonCivilRegistrationIdentifier) | 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 | CPR nummer på den borger beskeden omhandler. |
- borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 | Id på den besked der ønskes ændret status. |
- borgerbeskedsvarIdentifier (CitizenMessageReplyIdentifier) | guid | 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 | Id på det svar der ønskes ændret status. |
- beskedstatus (CitizenMessageStatusTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208885761 (Gl DFDG CitizenMessageStatusTypeIdentifierType) |
| 1 | Om svar er fejloprettet |
- berigtigelseskommentar (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
Tom |
|
|
|
|
SetMessageReplyStatusResponse | SetMessageReplyStatusResponseType |
| 1 |
|
- ServiceReceipt | ServiceReceiptType |
| 1 | Servicekvittering |
- - borgerbeskedIdentifier (MessageIdentifier) | guid | 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 identifikation af transaktion eller registrering |
- - EventDate | dateTime |
| 1 | Tidspunkt for transaktionen eller registreing |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
4013 | Unknown Client Destination | Unknown Client Destination |
4857 | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund | Borger tilhøre en anden a-kasse Citizen belongs to different unemployment fund |
6005 | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader |
8044 | Education plan type is not allowed for citizen above age 30 | Education plan type is not allowed for citizen above age 30 |
8060 | Operation is not allowed when citizen has no active contact group | Operation is not allowed when citizen has no active contact group |
8062 | A valid combination of contact group and person category is required for publish | A valid combination of contact group and person category is required for publish |
8069 | Cancel subscription is not possible. Citizen does not have an education event subscription | Subscription not possible. Citizen does not have an education event subscription |
8074 | Education plan type is not allowed for citizen above age 25 | Education plan type is not allowed for citizen above age 25 |
8140 | The submitted CitizenMessageStatusTypeIdentifier is invalid | The submitted CitizenMessageStatusTypeIdentifier is invalid |
8144 | The requested message could not be found | The requested message could not be found |
8160 | Status kan kun skiftes, hvis status er Aktiv | Status kan kun skiftes, hvis status er Aktiv |
8162 | Den angivet statusændring er ikke tillladt The requested change in status is not allowed | Den angivet statusændring er ikke tillladt The requested change in status is not allowed |
8163 | Status på svar er skal være aktiv for at status kan ændres The status of the reply is required to be active to allow status change | Status på svar er skal være aktiv for at status kan ændres The status of the reply is required to be active to allow status change |
8164 | Svar kunne ikke findes The requested reply could not be found | Svar kunne ikke findes The requested reply could not be found |
8211 | Der er ikke muligt at opdateret dette svar, da en anden har oprettet det You are not allowed to Update this messagereply since you did not create it | Der er ikke muligt at opdateret dette svar, da en anden har oprettet det You are not allowed to Update this messagereply since you did not create it |
8300 | Begrigtigelseskommentar der påkrævet med status Fejloprette Correction comment required for messages with status fejloprettet | Begrigtigelseskommentar der påkrævet med status Fejloprette Correction comment required for messages with status fejloprettet |
UpdateBesked (PUT /v1/BorgerBesked/{borgerbeskedIdentifier}/action/setmarkering)
(Gl. DFDG MarkMessage og JobnetCitizenMessageService (Version 2, 2016-4).MarkMessage)
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 |
|---|---|---|---|---|
statusmarkeringRequest (MarkMessageRequest) | MarkMessageRequestType |
| 1 |
|
- borgerbeskedIdentifier (CitizenMessageIdentifier) | guid | 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 | Id på den besked der ønskes markeret. Eventuelle svar, uden en markering, markeres også |
- statusmarkering (MarkMessageIdentifier) | https://starwiki.atlassian.net/wiki/spaces/ISB/pages/4208164902 (Gl. DFDG MarkMessageIdentifierType) |
| 1 | Angivelse af om en sagsbehandler har læst besked |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
Tom |
|
|
|
|
MarkMessageResponse | MarkMessageResponseType |
| 1 |
|
- ServiceReceipt | ServiceReceiptType |
| 1 | Servicekvittering |
- - borgerbeskedIdentifier (MessageIdentifier) | guid | 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 identifikation af transaktion eller registrering |
- - EventDate | dateTime |
| 1 | Tidspunkt for transaktionen eller registreing |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
8044 | Education plan type is not allowed for citizen above age 30 | Education plan type is not allowed for citizen above age 30 |
8060 | Operation is not allowed when citizen has no active contact group | Operation is not allowed when citizen has no active contact group |
8062 | A valid combination of contact group and person category is required for publish | A valid combination of contact group and person category is required for publish |
8069 | Cancel subscription is not possible. Citizen does not have an education event subscription | Subscription not possible. Citizen does not have an education event subscription |
8074 | Education plan type is not allowed for citizen above age 25 | Education plan type is not allowed for citizen above age 25 |
8144 | The requested message could not be found | The requested message could not be found |
9006 | The specified MarkMessageIdentifier is not valid | The specified MarkMessageIdentifier is not valid |
9007 | En arkiveret besked kan ikke blive markeret An archived message cannot be marked | En arkiveret besked kan ikke blive markeret An archived message cannot be marked |
Getbeskeddokument (GET /v1/BorgerBested/Dokument/{DocumentIdentifier})
(Gl. DFDG GetCitizenMessageDocument)
borgerkommunikation.borgerbesked.write
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getBeskedDokumentRequest (GetCitizenMessageDocumentRequest) | GetCitizenMessageDocumentRequestType |
| 1 |
|
- x-civilRegistrationIdentifier [Header] (PersonCivilRegistrationIdentifier) | 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 | Borgers personnummer. |
- DocumentIdentifier (CitizenMessageDocumentIdentifier) | guid | 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 | ID på dokument. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getDokumentResponse GetCitizenMessageDocumentResponse | GetCitizenMessageDocumentResponseType |
| 1 |
|
- dokumentdata (CitizenMessageDocument) | base64Binary |
| 1 | Selve dokument base 64 encoded |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
4575 | You are not authorized | You are not authorized to execute the operation |
6005 | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader | Det angivende CPR nummer tilhører ikke det jobcenter der er angivet i ActiveOrganisationHeader The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader |
8103 | Dokument findes ikke The Document does not exist. | Dokument findes ikke The Document does not exist. |