Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 10 Next »

FManuel opdateret side - udviklingsversion.

Metoder

GetPersonKommunikationStatus (GET /v2/BorgerkommunikationStatus)

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

A-kasse

X

Fra 120 dage inden medlemskab til 120 dage efter medlemskab

X

JobCenter

X

X

X

X

X

Kommune

X

X

STAR

X

Scope

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

personstatusstruktur [Query]

boolean

0 - 1

Inputvariabel til output

personkommentarer [Query]

boolean

0 - 1

Inputvariabel til output

gaesteadgang [Query]

boolean

0 - 1

Inputvariabel til output

personnummerHistorik [Query]

boolean

0 - 1

Inputvariabel til output

adresse [Query]

boolean

0 - 1

Inputvariabel til output

boernUnder18 [Query]

boolean

0 - 1

Inputvariabel til output

andenaktoerhenvisning [Query]

boolean

0 - 1

Inputvariabel til output

personFagprofessionelKontakt [Query]

boolean

0 - 1

Inputvariabel til output

Output

Signatur

Hvid baggrund = Data allerede etableret i tidligerer versioner, der er til rådighed se Borgerkommunikation.BorgerkommunikationStatusService (Version 2, 2024-2)

Grøn baggrund = Data de etableres i forbindelse med release 2024-4

Blå baggrund = Data der er tænkt til senere release (senere end 2024-4) i forbindelse med STAR flytter forretningsområdet til borgerkommunikation

Gul = Felter eller andet hvor det udestår en forretningsmæssig eller teknisk afklaring

Grå = Felter med hjælpetekst til læsning af snitflade

Udgår ift. PSS

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetPersonKommunikationStatusResponseDto

1

-    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
MinLength: 1

1

Borgers personnummer

<Forretningsområde - Borgerstamdata>

Allerede etableret

-    personstatusstruktur

(PersonCoreInfo)

PersonstatusstrukturDto

0 - 1

-    -    personstatus

(PersonCivilRegistrationStatusCode)

PersonCivilRegistrationStatusTypeCodeList

1

-    -    navnestruktur

(PersonNameStructure)

NavnestrukturDto

0 - 1

-    -    -    fornavne

(PersonGivenName)

string

Length: 1-50

1

Erklæring af personens fornavn(e).

-    -    -    mellemnavn

(PersonMiddleName)

string

Length: 1-40

0 - 1

Erklæring af personens mellemnavne(e).

-    -    -    efternavn

(PersonSurnameName)

string

Length: 1-40

1

Erklæring af en persons efternavne(e).

-    -    statsborgerskab

(CitizenshipCode)

LandeTypeIdentifierCodeList

(CountryTypeIdentifierType)

1

Statsborgerskab, hvis flere og det ene er dansk vil det danske være angivet her.
CPR-registret udstiller kun et statsborgerskab

-    -    indrejsedato

(ImmigrationDate)

date-time

0 - 1

Dato for immigrering til Danmark.

- - foedselsdato

(BirthDate)

date

 

1

Borgers fødselsdato

-    -    bopaelskommunekode

int32

0 - 1

Bopælskommunekode. Udstilles for kommunenr. 101 - 851. Ellers tom.

-    -    jobcentertilknytning

JobcentertilknytningDto

1

-    -    -    jobcenterKode

(JobcenterIdentifier)

int32

Pattern: [1-9][0-9]{4}

1

Jobcentres kode

-    -    -    jobcenterNavn

(JobcenterName)

string

Length: 1-100

1

Jobcentres navn

-    -    -    kommunekodeSamling

(MunicipalityCodeCollection)

stringCollection

1

Kommuner som jobcentret repræsenterer. (Af tekniske årsager har denne elementlistes elementer ikke navn og beskrivelse)

-    -    -    -    string

string

0 - *

- - borgersKoen

(PersonGenderCode)

KoenTypeCodeList

Enumeration:

  • male

  • female

  • unspecified

0 - 1

 Borgers køn

- - nordiskBorger

(NordicCitizen)

Booelan

Enumeration:

  • Yes

  • No

0 - 1

Angiver om borgeren er nordisk statsborger

- - civilstatus

(MaritalStatusCode)

Borgerkommunikation.CivilstandsTypeCodeList

0 - 1

Angiver borgerens civilstand og om personen er levende eller død.

<Forretningsområde - Personkommentar>

Allerede etableret

-    personkommentarer

(PersonCommentCollection)

PersonkommentarDtoCollection

1

Samling af generelle statuskommentarer tilknyttet personen ud fra(populært kaldet AMP kommentarfeltet).

-    -    PersonkommentarDto

PersonkommentarDto

0 - *

-    -    -    personkommentarId

(MessageIdentifier)

uuid

1

Unik nøgle

-    -    -    kommentar

(CommentText)

string

Length: 1-1000

1

Kommentartekst

-    -    -    registreringstidspunkt

(EventDate)

date-time

1

Hændelsesdato for registreringen

-    -    -    sagsbehandler

(CaseWorkerStructure)

SagsbehandlerDto

1

-    -    -    -    brugerId

(CaseWorkerRID)

string

Length: 1-64

1

Sagsbehandlerens RID fra medarbejder OCES certifikatet..

-    -    -    -    brugerFuldtNavn

string

Length: 1-140

1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    registrerendeMyndighed

(AuthorityStructure)

RegistrerendeMyndighedDto

1

-    -    -    -    organisationType

OrganisationTypeCodeList

0 - 1

-    -    -    -    organisationskode

( AuthorityCode)

string

Pattern: [-][1]|[0-9]{1,8}
Length: 1-20

1

Myndighedskode.

<Forretningsområde - Gæsteadgang>

Allerede etableret

- gaesteadgange

GaesteadgangDtoCollection

1

Samling af generelle statuskommentarer tilknyttet personen ud fra(populært kaldet AMP kommentarfeltet).

-    -    GaesteadgangDto

GaesteadgangDto

0 - *

-    -    -    gaesteadgangId

(MessageIdentifier)

uuid

1

Unik nøgle

-    -    -    gaesteadgangskommentar

(CommentText)

string

Length: 1-1000

1

Kommentartekst

-    -    -    dfdgRegisteringstidspunkt

(EventDate)

date-time

1

Hændelsestidspunkt for registreringen i DFDG

-    -    -    registerendeBruger

SagsbehandlerDto

1

-    -    -    - brugerId

(CaseWorkerRID)

string

Length: 1-64

1

Sagsbehandlerens RID fra medarbejder OCES certifikatet..

-    -    -    -    brugerFuldtNavn

(CaseWorkerStructure)

string

Length: 1-140

1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    registrerendeMyndighed

(AuthorityStructure)

RegistrerendeMyndighedDto

1

-    -    -    -    organisationType

OrganisationTypeCodeList

0 - 1

-    -    -    -    organisationskode

( AuthorityCode)

string

Pattern: [-][1]|[0-9]{1,8}
Length: 1-20

1

Myndighedskode.

<Forretningsområde - Borgerstamdata/Personhistorik>

Release 2024-1

-    personnummerHistorik

(PersonCivilRegistrationIdentifierHistoryCollection

PersonnummerHistorikCollectionDto

0 - 1

Borgerens tidligere cpr-numre.

-    -    personnummer

(PersonCivilRegistrationIdentifierHistoryType)

tidligereCPRnummerDto

0 - *

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

Borgers cpr-nr

-    -    -    personnummerstatus

(PersonCivilRegistrationStatusCode)

Int

MinInclusive: 1

1

Statuskode for borger fra CPR

-    -    -    slutdato

PersonCivilRegistrationIdentifierIncidentdate

dateTime

0 - 1

Slutdato for borgers CPR-nrs gyldighed

<Forretningsområde - Borgerstamdata/adresse>

Release 2024-1

-    adressestruktur

 

0 - 1

 

-    -    navneOgAdressebeskyttelseStartdato

DateTime?

 

0 - 1

 Startdato for navne og adresse beskyttelse

-    -    navneOgAdressebeskyttelseSlutdato

DateTime?

 

0 - 1

 Slutdato for navne og adresse beskyttelse

-    -    adresse

Star.Borgerkommunikation.Events.Model.AdresseStruktur

 

0 - 1

 

-    -    -    coNavn

String

 

0 - 1

 

-    -    -    vejnavn

String

Length: 1-40

1

 

-    -    -    husnummer

String

Pattern: [0-9]{0,6}[a-zA-Z]
(^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$)

1

 

-    -    -    etage

String

Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$

0 - 1

 

-    -    -    sideDoer

String

Length: 1-4

0 - 1

 

-    -    -    bygningsnummer

String

 

0 - 1

 

-    -    -    bynavn

String

Length: 1-34

0 - 1

 

-    -    -    postnummer

String

1 - 10

1

 

-    -    -    postdistrikt

String

Length: 1-20

1

 

-    -    -    landekode

String

Pattern: ^[a-z,A-Z]{2}$|^[a-z,A-Z]{3}$|^[0-9]{3}$|^[0-9]{4}$

0 - 1

 

-    -    DarAdresse

String

 

0 - 1

 GUID

-    -    GeokoordinatStruktur

Star.Borgerkommunikation.Events.Model.GeokoordinatStruktur

 

0 - 1

 

-    -    -    Breddegrad

Double

 

1

 

-    -    -    Laengdegrad

Double

 

1

 

<Forretningsområde - Borgerstamdata/adresse/midlertidigadresse>

Release Skal endelig fastlægges

-    -    startdato

DateTime

1

Startdatoen for den midlertidige adresse.

-    -    slutdato

DateTime

0 - 1

Slutdatoen for den midlertidige adresse. (occurrence kan kun være 0 for personer med cpr status inaktiv –’Grænsegængere’)

-    - adresse

Star.Borgerkommunikation.Events.Model.AdresseStruktur

 

0 - 1

 

-    -    - coNavn

String

 

0 - 1

 

-    -    - vejnavn

String

Length: 1-40

1

 

-    -    - husnummer

String

Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$

1

 

-    -    - etage

String

Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$

0 - 1

 

-    -    - sideDoer

String

Length: 1-4

0 - 1

 

-    -    - bygningsnummer

String

 Length: 1-34

0 - 1

 

-    -    - bynavn

String

Length: 1-34

0 - 1

 

- -    -    postnummer

String

1 - 10

1

 

- -    -    postdistrikt

String

Length: 1-20

1

 

- -    -    landekode

String

Pattern: ^[a-z,A-Z]{2}$|^[a-z,A-Z]{3}$|^[0-9]{3}$|^[0-9]{4}$

0 - 1

 

<Forretningsområde - Borgerstamdata/Børn>

Release 2024-1

-    boernUnder18

(FamilyMemberCollection)

BoernUnder18DtoCollection

 

0 - 1

Liste med tilknyttede børn under 18 år hvor der er forsørgelsespligt

-    -    barn

(FamilyMemberType

BarnDto

 

0 - *

 

-    -    -    foedselsdato

(BirthDate)

date

 

1

Barnets fødselsdatoen

-    -    maandeOgAarFor18Aar

(BirthdayEighteenYears)

string

Length: 7-7

1

Måned hvor barnet fylder 18 år i formatet MM/YYYY, fx 12/2016

-    -    opholdsland

(ResidenceCountry)

CountryTypeIdentifierType

XXXX? hvor skal denne kodelist bo?

 

1

Barnets opholdsland

<Forretningsområde - Anden Aktør forløb>

Release 2024-1

-    andenaktoerhenvisning

AndenaktoerhenvisningDto

 

0 - 1

 Aktuel henvisning

-    -    henvisningsId

uuid

 

1

Unik identifikation af anden aktør henvisning

-    -    eksternSystemAftaleId

uuid

 

0 - 1

Id på delaftale i det ekstern system

-    -    cvrEnhedsid

string

Length: 0-8

1

Anden aktørs CVR-nummer.

-    -    pNummer

string

Length: 0-10

1

P-nr på anden aktør

-    -    startDato

date

 

1

Dato for anden aktør henvisningens start.

-    -    slutDato

date

 

1

Dato for anden aktør henvisningens afslutning.

-    -    dfdgRegisteringstidspunkt

date-time

 

1

Dato for anden aktør henvisningens start.

-    -    erAnnulleret

boolean

 

1

Om Anden Aktør henvisning er annulleret eller ej

-    -    kommentar

string

 

0 - 1

Kommentar

-    -    sagsbehandler

SagsbehandlerDto

 

1

 

-    -    -    brugerFuldtNavn

string

Length: 1-140

0 - 1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    brugerId

string

Length: 1-64

1

Sagsbehandlerens RID fra medarbejder OCES certifikatet eller andet entydigt id

-    -    registrerendeMyndighed

RegistrerendeMyndighedDtoBase

 

1

 

-    -    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Identifikation af organisation / myndighed

<Forretningsområde - Fagprofessionel kontakt>

Release 2024-1

-    fagprofessionelleKontakter

(PersonContactCollection)

PersonFagprofessionelKontaktDtoCollection

1

Liste af borgerens aktuelle kontaktpersoner.

-    -    personFagprofessionelKontakt

(PersonContactType)

PersonFagprofessionelKontaktDto

0 - *

-    -    -    fagprofessionelKontaktId

(PersonContactIdentifier)

uuid

0 - 1

Identifikation af kontaktpersontilknytningen. Hvis kontaktpersonen er mentor eller udslusningskoordinator er værdien null.

-    -    -    fagprofessionelKontaktNavn

(PersonContactName)

string

Length: 1-250

1

Navn (fornavn, mellemnavn, efternavn) på kontaktpersonen.

-    -    -    fagprofessionelKontaktType

(PersonContactTypeIdentifier)

FagprofessionelKontaktTypeCodeList

(Gl. DFDG PersonContactTypeIdentifierType)

1

Identifikation af kontaktpersontilknytningen.

-    -    - eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    -    -    telefonnummer

(TelephoneNumberIdentifier)

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Telefonnummer inkl. internationalt prefix.

-    -    -    mobilnummer

(MobileNumberIdentifier)

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Mobilnummer inkl. internationalt prefix

-    -    -    emailadresse

(EmailAddressIdentifier)

string

Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})

0 - 1

Emailadresse.

-    -    -    startDato

(StartDate)

dateTime

1

Startdato for tilknytning af kontaktperson.

-    -    -   slutDato 

(EndDate)

dateTime

0 - 1

Slutdato for tilknytning af kontaktperson.

-    -    -    kommentarTilBorger

(CommentToCitizen)

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet.

-    -    -    kommentarTilSagsbehandler

(CommentToCaseWorker)

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter.

-    -    -    kontaktSkalVisesForBorger

(ShowContactPersonInJobnet)

boolean

1

Skal kontaktpersonen vises på Jobnet med denne rolle for borgerne.

-    -    -    ansvarligMyndighed

(ResponsibleAuthority)

AnsvarligMyndighedDto

1

Den myndighed som har oprettet kontaktpersonen.

-    -    -    -    organisationKode

(AuthorityCode)

string

Pattern: [-][1]|[0-9]{1,8}

1

Myndighedskode.

-    -    -    -    organisationType

(OrganisationTypeIdentifier)

OrganisationTypeIdentifierType

1

Myndighedstype

-    -    -    - clientSystemType

ClientSystemTypeCodeList

 

1

 Klientsystem hvor kontaktpersonen er oprettet

-    -    -    - cvrnummer

string

Length: 0-8

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    -    - produktionsenhedsnummer

string

Length: 0-10

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

-    -    -    dfdgRegistreringstidspunkt

(DFDGRegistrationDateTime)

dateTime

1

Tidspunkt hvor hændelsen/data er registreret i DFDG

<Forretningsområde - Borgerkontaktdata>

OBS!!! DET SKAL AFKLARES HVILKE FELTER DER SKAL MED

Release Skal endelig fastlægges

- borgerKontaktInformation

(PersonContactDataInfo)

BorgerKontaktInformationDto

 

0 - 1

Huskeservice kontaktinformation. Kun aktuel status.

-    - kontaktinformationer

(PersonContactDataInfoCollection)

KontaktinformationerDto

 

0 - 1

Liste med borgers egne kontaktoplysninger

-    -    - kontaktinformation

(PersonContactDataType)

KontaktinformationDto

 

0 - *

Borgers kontaktdata.

-    -    -    - kontaktdata

string

 

1

Angivelse af mobiltelefon, fastnet telefon eller mailadresse. Hvis NULL angives eller elementet udelades slettes den angivne type af kontaktinformation.

-    -    -    - kontaktdatatype

(PersonContactDataTypeIdentifier)

Borgerkommunikation.KontaktdataCodelList

(Gl. DFDG PersonContactDataTypeIdentifierType)

 

1

Borgers kontaktform.

-    -    -    - registreringstidspunkt

(RegistrationDateTime)

dateTime

 

1

Registreringsdato fra DFDG

-    -    -    - status

(PersonContactDataStatusTypeIdentifier)

Borgerkommunikation.KontaktdataStatusCodelList

(Gl. DFDG PersonContactDataStatusTypeIdentifierType)

 

1

Status på kontaktinfo.

-    -    - myndighed

(ResponsibleAuthority)

AnsvarligMyndighedDto

1

Den myndighed som har oprettet kontaktpersonen.

-    -    -    - organisationKode

(AuthorityCode)

string

Pattern: [-][1]|[0-9]{1,8}

1

Myndighedskode.

-    -    -    - organisationType

(OrganisationTypeIdentifier)

OrganisationTypeIdentifierType

1

Myndighedstype

<Forretningsområde - Dialogmodul>

Release Skal endelig fastlægges

-    Borgerbeskedbakke

(CitizenMessageInfo)

BorgerbeskedbakkeDto

1

-    -    ulaesteBeskeder

(UnreadMessageCollection)

UlaesteBeskederDto

0 - 1

Indeholder liste af de beskeder borgeren endnu ikke har læst

Bemærk oversættelse til dansk kommer senere

-    -    -    CitizenMessageType

CitizenMessageType

0 - *

-    -    -    -     borgerbeskedIdentifier

(MessageIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik ID for meddelelsen

-    -    -    -    organisationskode (OrganisationCode)

Borgerkummunikation.BeskedIndholdsTypeCodeList

(Gl. DFDG CitizenMessageContextTypeIdentifierType)

1

Kodelisteværdi der fortæller den kontekst meddelelsen er blevet oprettet under

-    -    -    -    afsender

(CreatedByUser)

AfsenderDto

1

Indeholder informationer om den person som er ophavsmand til meddelelsen

-    -    -    -    -    brugertype

(UserTypeIdentifier)

Borgerkummunikation.BrugerTypeCodelist

(Gl. DFDG CitizenMessageUserTypeIdentifierType)

1

Angiver om user enten er borger eller sagsbehandler

-    -    -    -    -    UserIdentifier

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

(FullName)

string

1

Sagsbehandlers eller borgerens fulde navn .

-    -    -    -    -    virksomhed (Company)

CitizenMessageCompanyType

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
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Identifikation af kontaktperson hos virksomhed (arbejdsgiver)

-    -    -    -    -    organisationType (OrganisationTypeIdentifier)

OrganisationTypeIdentifierType

1

Kun relevant hvis UserTypeIdentifier er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse

-    -    -    -    -    organisationskode (OrganisationCode)

string

0 - 1

Kun relevant hvis UserTypeIdentifier 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

(CitizenMessageRecipient)

string

0 - 1

Indeholder den myndighed der skal indgå i meddelelsen og stå som modtager.

-    -    -    -    -    organisationType (OrganisationTypeIdentifier)

int

1

Organisationstype.

-    -    -    -    -    organisationskode (OrganisationCode)

string

1

Organisationskode.

-    -    -    -    afsendelseskanal

(CitizenMessageChannelTypeIdentifier)

Borgerkommunikation.AfsendelsesKanaltypeCodeListe

(Gl. DFDG CitizenMessageChannelTypeIdentifierType)

1

Angiver om meddelelsen er en SMS, MAIL, notifikation på Jobnet eller en trådbaseret meddelelse

-    -    -    -    besvarelsestype

(CitizenMessageResponseTypeIdentifier)

Borgerkommunikation.BesvarelsestypeCodeList

Gl DFDG CitizenMessageResponseTypeIdentifierType)

1

Angiver om borger eller sagsbehandler må besvare på de beskeder der indgår i tråden.

-    -    -    -    beskedsvar

(MessageReplyCollection)

BeskedsvarDto

0 - 1

Indeholder en liste over alle de retursvar der er oprettet til denne dialog

-    -    -    -    -    CitizenMessageReplyType

CitizenMessageReplyType

0 - *

-    -    -    -    -    -    MessageReplyIdentifier

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

-    -    -    -    -    -    afsender

(CreatedByUser)

CitizenMessageUserType

1

Indeholder informationer om den person der har svaret på beskeden

-    -    -    -    -    -    -    UserTypeIdentifier

CitizenMessageUserTypeIdentifierType

1

Angiver om user enten er borger eller sagsbehandler

-    -    -    -    -    -    -    UserIdentifier

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

(FullName)

string

1

Sagsbehandlers eller borgerens fulde navn .

-    -    -    -    -    -    -    virksomhed (Company)

CitizenMessageCompanyType

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
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Identifikation af kontaktperson hos virksomhed (arbejdsgiver)

-    -    -    -    -    -    -    organisationType (OrganisationTypeIdentifier)

OrganisationTypeIdentifierType

1

Kun relevant hvis UserTypeIdentifier er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse

-    -    -    -    -    -    -    organisationskode (OrganisationCode)

string

0 - 1

Kun relevant hvis UserTypeIdentifier er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse.

-    -    -    -    -    -    Tekst (Text)

string

1

Tekst retursvar indeholder

-    -    -    -    -    -    oprettelsestidspunkt

(CreatedDate)

dateTime

1

-    -    -    -    -    -    beskedstatus

(StatusTypeIdentifier)

Borgerkommunikation.BorgerBeskedStatusGodeList

(Gl DFDG CitizenMessageStatusTypeIdentifierType)

1

-    -    -    -    -    -    vedhaeftetDokumenter (MessageDocumentCollection)

VedhaeftetDokumenterDto

0 - 1

Kollektion af vedhæftede dokumenter

-    -    -    -    -    -    -    MessageDocumentType

MessageDocumentType

0 - *

-    -    -    -    -    -    -    -    vedhaeftetDokumenter (dokumentidentifier)

(DocumentID)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

0 - 1

Entydig nøgle

-    -    -    -    -    -    -    -    dokumenttitel (DocumentTitle)

string

Length: 1-260

1

Titel på dokumentet.

-    -    -    -    -    -    -    -    dokumentfiltype (DocumentExtensionIdentifier)

DocumentExtensionIdentifierType

1

Dokumenttype.

-    -    -    -    -    -    -    -    DocumentSchemaTypeIdentifier

DocumentSchemaTypeIdentifierType

0 - 1

-    -    -    -    -    -    -    -    dokumentdata (DocumentData)

base64Binary

0 - 1

Selve dokumentet indgår aldrig her, men kan hentes med metoden GetCitizenMessageDocument.

Så kan det vel udgå her?

-    -    -    -    -    -    beskedstatusmarkeringer

(CitizenMessageMarkCollection)

BeskedstatusmarkeringerDto

1

Kollektion af markeringer for visning og læsning

-    -    -    -    -    -    -    beskedstatusmarkering (CitizenMessageMark)

BeskedstatusmarkeringDto

0 - *

-    -    -    -    -    -    -    -    statusmarkering (MarkMessageIdentifier)

Borgerkommunikation.BeskedMarkeringsstatusCodeList

(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

-    -    -    -    beskedstatus

(StatusTypeIdentifier)

Borgerkommunikation.BorgerBeskedStatusGodeList

(Gl DFDG CitizenMessageStatusTypeIdentifierType)

1

Kodeliste der indikerer om dialogen er aktiv, lukket, fejloprettet

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

Borgerkommunikation.VigtigthedsniveautypeCodeList

(Gl. DFDG MessageImportantIdentifierType)

1

Angiver hvor vigtig beskeden er for borger

-    -    -    -    vedhaeftetDokumenter (MessageDocumentCollection)

VedhaeftetDokumenterDto

0 - 1

Kollektion af vedhæftede dokumenter

-    -    -    -    -    MessageDocumentType

MessageDocumentType

0 - *

-    -    -    -    -    -    vedhaeftetDokumenter (dokumentidentifier)

(DocumentID)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

0 - 1

Entydig nøgle

-    -    -    -    -    -    dokumenttitel (DocumentTitle)

string

Length: 1-260

1

Titel på dokumentet.

-    -    -    -    -    -    dokumentfiltype (DocumentExtensionIdentifier)

DocumentExtensionIdentifierType

1

Dokumenttype.

-    -    -    -    -    -    DocumentSchemaTypeIdentifier

DocumentSchemaTypeIdentifierType

0 - 1

-    -    -    -    -    -    dokumentdata (DocumentData)

base64Binary

0 - 1

Selve dokumentet indgår aldrig her, men kan hentes med metoden GetCitizenMessageDocument.

Så kan det vel udgå her?

-    -    -    -    beskedstatusmarkeringer

(CitizenMessageMarkCollection)

BeskedstatusmarkeringerDto

1

-    -    -    -    -    beskedstatusmarkering (CitizenMessageMark)

BeskedstatusmarkeringDto

0 - *

-    -    -    -    -    -    statusmarkering (MarkMessageIdentifier)

Borgerkommunikation.BeskedMarkeringsstatusCodeList

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

-    -    -    -    CitizenMessageTagCollection

CitizenMessageTagTypeCollection

1

-    -    -    -    -    CitizenMessageTagType

CitizenMessageTagType

0 - *

-    -    -    -    -    -    afsender

(CreatedByUser)

CitizenMessageUserType

1

-    -    -    -    -    -    -    UserTypeIdentifier

CitizenMessageUserTypeIdentifierType

1

Angiver om user enten er borger eller sagsbehandler

-    -    -    -    -    -    -    UserIdentifier

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

(FullName)

string

1

Sagsbehandlers eller borgerens fulde navn .

-    -    -    -    -    -    -    virksomhed (Company)

CitizenMessageCompanyType

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
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Identifikation af kontaktperson hos virksomhed (arbejdsgiver)

-    -    -    -    -    -    -    organisationType (OrganisationTypeIdentifier)

OrganisationTypeIdentifierType

1

Kun relevant hvis UserTypeIdentifier er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse

-    -    -    -    -    -    -    organisationskode (OrganisationCode)

string

0 - 1

Kun relevant hvis UserTypeIdentifier er lig sagsbehandler. Angivelse af organisationskode for Jobcenter eller A-kasse.

-    -    -    -    -    -    CitizenMessageTag

string

1

-    -    -    -    -    -    haendelsestidspunkt (EventDate)

dateTime

1

-    -    -    -    berigtigelseskommentar (CorrectionComment)

string

Length: 0-1500

0 - 1

<Forretningsområde - Huskeservice>

Release Skal endelig fastlægges

- huskeserviceabonnement

(PersonNotificationInfo)

HuskeserviceabonnementerDto

 

0 - 1

Huskeserviceabonnementer. Kun aktuel status.

-    - abonnementer

(PersonNotificationCollection)

AbonnementerDto

 

0 - 1

 

-    -    -    OensketSMSNotifikationer

(AllowTextNotificationCollection)

smsNotifikationDto

 

0 - 1

Kollektion af de notifikationstyper, som der ønskes abonnement på via SMS.

-    -    -    -    NotifikationType

(NotificationTypeIdentifierType)

Borgerkommunikation.NotifikationstypeCodelist

(Gl. DFDG NotificationTypeIdentifierType)

 

0 - *

 

-    -    -    OensketEmailNotifikationer

(AllowEmailNotificationCollection)

NotificationTypeIdentifierTypeCollection

 

0 - 1

Kollektion af de notifikationstyper, som der ønskes abonnement på via e-mail.

-    -    -    -    NotifikationType

(NotificationTypeIdentifierType)

Borgerkommunikation.NotifikationstypeCodelist

(Gl. DFDG NotificationTypeIdentifierType)

 

0 - *

 

<Forretningsområde - A-kasse medlemsskab>

Release Skal endelig fastlægges

- akassemedlemsskab

(UnemploymentFundInfo)

AkassemedlemsskabDto

 

0 - 1

A-kasse informationer om aktuel medlems a-kasse

-    -    akassekode

(UnemploymentFundCode)

int

MinInclusive: 0
MaxInclusive: 99

1

Kode på a-kasse.

  • -    -    UnemploymentFundName

string

Length: 1-100

1

Navn på a-kasse.

-    -    akasseafdelingskode

(UnemploymentFundBranchCode)

int

MinInclusive: 0
MaxInclusive: 999999

0 - 1

Kode på a-kasse afdeling / kontor.

  • -    -   UnemploymentFundBranchName

string

Length: 1-100

1

Navn på a-kasse kontor.

-    - forsikringskategori

(UnemploymentInsuranceCategoryTypeIdentifier)

Borgerkomminikation.ForsikringskategoriCodelist

(Gl. DFAG kodeliste UnemploymentInsuranceCategoryTypeIdentifierType)

 

0 - 1

Forsikringskategori.

-    -    UnemploymentFundWebSite

string

0 - 1

Web site på a-kasse. Max 4000 tegn
Er i JCSS

<Forretningsområde - Persongrupper>

Release Skal endelig fastlægges

- persongruppetilknytninger

(PersonGroupMarkingInfo)

PersongruppetilknytningerDto

 

0 - 1

Persongruppemarkeringer. Incl. historiske data. Jesper Brunholm skal vi det her?

-    -    persongruppetilknytning

(PersonGroupMarkingType)

PersongruppetilknytningDto

 

0 - *

 Persongruppemarkering

-    -    -    persongruppetilknytningIdentifier

(MessageIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik nøgle

-    -    -    starttidspunkt

(PersonGroupMarkingStartTime)

dateTime

 

1

Startdato og tidspunkt.

-    -    -    sluttidspunkt

(PersonGroupMarkingEndTime)

dateTime

 

0 - 1

Slutdato og tidspunkt.

-    -    -    projektnavn

(PersonGroupProjectName)

string

Length: 1-100

1

 Personprojektetsnavn

-    -    -    projektIdentifier

(PersonGroupProjectIdentifier),

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Guid tilknytning til et oprettet persongruppeprojekt

-    -    -    berigtigelseskommentar

(CorrectionComment)

string

Length: 0-1500

0 - 1

 Berigtigelseskommentar

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

60006

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

GetBorgerNemSMSabonnement (GET /v2/NemSMSabonnement)

Henter information om hvorvidt en borger er tilmeldt NemSMS eller ej.

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

STAR

X

Scope

borgerkommunikation.staronly.read

Nyt scope!

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

x-civilRegistrationIdentifier [Header]

PersonCivilRegistrationIdentifierType
Base: 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

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

getPersonNemSMSabonnementResponse

(GetPersonNemSMSSubscriptionResponse)

GetPersonNemSMSabonnementResponseDto

1

Svaret på forespørgslen om en borgers NemSMS tilmeldingsstatus.

- personNemSMSabonnement

PersonNemSMSabonnementDto

0 - 1

Information om borgerens NemSMS tilmeldingsstatus

-    - NemSMSabonnement

(PersonSubscribed)

boolean

1

Indikerer hvorvidt borgeren er tilmeldt NemSMS eller ej.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

9399

NemSMS service unhandled error

NemSMS service unhandled error

  • No labels