Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Denne service gør det muligt at oprette og redigere persongruppeprojekter, samt at fremsøge persongruppemarkeringer i persongruppeprojekterne.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterResponse
(GetPersonGroupProjectsResponse)

GetPersonGruppeProjekterResponseType
(GetPersonGroupProjectsResponseType)

1

-    personGruppeProjekter
(PersonGroupProjects)

PersonGruppeProjekterDto
GetPersonGroupProjectTypeCollection

1

Placeholder for liste af persongruppeprojekt objekter.

-    -    personGruppeProjekt
(GetPersonGroupProjectType)

personGruppeProjektDto
(GetPersonGroupProjectType)

0 - *

Indholder liste af persongruppeprojekt objekter.

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

Identifikation af persongruppeprojektet.

-    -    -    personGruppeProjekt
(PersonGroupProjectItem)

PersonGruppeProjektDto
(GetPersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    - starttidspunkt  starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    - sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

-    -    - anvendendeOrganisationstype
(PersonGroupProjectTypeIdentifier)

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Projekttypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier

-    -    - projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

-    -    - deltagerIndikatorPåProjektType
(ParticipationIndicatedByProjectType)

boolean

1

Indikation på at deltagende myndigheder kun er angivet i kraft af projekttypen, da alle myndigheder deltager i denne projekttype.

-    -    - deltagendeMyndigheder
(ParticipatingAuthorities)

deltagendeMyndighederDto
(ParticipatingAuthorityTypeCollection)

1

En liste med deltagende myndigheder (a-kasser og jobcentre). Ved projekter af typen 1 - Stat - jobcentre er listen tom idet feltet ParticipationIndicatedByProjectType=true indikerer at alle jobcentre deltager.

-    -    -    - deltagendeMyndighed
(ParticipatingAuthorityType)

deltagendeMyndighedDto
(ParticipatingAuthorityType)

0 - *

En deltagende myndighed

-    -    -    -    - organisationKode
(AuthorityCode)

string

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

1

Myndighedskode

-    -    -    -    - OrganisationType
(OrganisationTypeIdentifier)

OrganisationTypeCodeList
(OrganisationTypeIdentifierType)

1

Myndighedstype

-    - berigtigelseskommentar  berigtigelseskommentar
(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

borgerkommunikation.read

Input

Forespørgsel som indeholder data vedr. den persongruppetilknytning der ønskes.

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeMarkeringsRequest
(GetPersonGroupMarkingRequest)

GetPersonGruppeMarkeringsRequest
(GetPersonGroupMarkingRequestType)

1

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeMarkeringsRequest
(GetPersonGroupMarkingRequest)

GetPersonGruppeMarkeringsRequest
(GetPersonGroupMarkingRequestType)

1

Forespørgsel som indeholder data vedr. den persongruppetilknytning der ønskes.

x-civilRegistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

x-requestId [Header]

string

 

1

Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

requestBody

 

 

1

 

-    MarkeringsIdentifier
(PersonGroupMarkingIdentifier)

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 en specifik persongruppetilknytning.

-    x-civilRegistrationIdentifier
(PersonCivilRegistrationIdentifier)

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

Personnummer

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeMarkeringsResponse

GetPersonGroupMarkingsResponseType

1

Svar som indeholder persongruppetilknytning.

-    personGruppeMarking
(PersonGroupMarking)

PersonGruppeMarkingDto
(PersonGroupProjectMarkingType)

0 - 1

En persongruppetilknytning

-    -    markeringsIdentifier
(PersonGroupMarkingIdentifier)

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

-    -    x-civilRegistrationIdentifier
(PersonCivilRegistrationIdentifier)

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

CPR-nr på borgeren som er knyttet til persongruppeprojektet.

-    -    navnestruktur
(PersonNameStructure)

NavnestrukturDto
(PersonNameStructureType)

1

Indholder detaljer af borgerens navn

-    -    -    fornavne
(PersonGivenName)

string
(PersonGivenNameType
Base: string)

Length: 1-50

1

Erklæring af personens fornavn(e).

-    -    -    mellemnavn
(PersonMiddleName)

string
(PersonMiddleNameType
Base: string)

Length: 1-40

0 - 1

Erklæring af personens mellemnavne(e).

-    -    -    efternavn
(PersonSurnameName)

string
(PersonSurnameNameType
Base: string)

Length: 1-40

1

Erklæring af en persons efternavne(e).

-    -    postnummer
(PostCodeIdentifier)

string
(PostCodeIdentifierType
Base: string)

Pattern: [0-9]{4}

1

Postnummeret for borgers bopæl

-    -    UnemploymentFundInfo

UnemploymentFundInfoType

0 - 1

Borgers aktuelle a-kasse, udfyldes kun ved type 5 projekter

-    - akassekode
(UnemploymentFundCode)

int

MinInclusive: 0
MaxInclusive: 99

1

Kode på a-kasse.

-    -    -    UnemploymentFundName

string

Length: 1-100

1

Navn på a-kasse.

-    -    JobcenterInfo

JobcenterInfoType

1

Borgers aktuelle jobcenter.

-    - jobcenterKode

(JobcenterIdentifier)

string

Pattern: [0-9]{5}

1

Kode på jobcenter

-    -    -    JobcenterName

string

Length: 1-100

1

Navn på jobcenter

-    -    ansvarligMyndighed

(ResponsibleAuthority)

ResponsibleAuthorityType

1

Den myndighed som har oprettet tilknytningen og kan opdatere den

-    -    -    organisationKode
(AuthorityCode)

string

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

1

Myndighedskode for ansvarlig myndighed

-    -    -    organisationType (OrganisationTypeIdentifier)

OrganisationTypeCodeList
OrganisationTypeIdentifierType

1

Myndighedstype, ansvarlig myndighed

-    -    -    navn
(UserFullName)

string

Length: 1-140

1

Sagsbehandlers navn aht. kontakt mhp. samarbejde

-    -    -    eksterntId
(UserIdentifier)

string

Length: 1-255

1

Sagsbehandlers id

-    -    -    emailadresse
(UserEmail)

string

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

0 - 1

Sagsbehandlers email aht. kontakt mhp. samarbejde

-    -    -    opdateringsTidspunkt
(MarkingUpdatedDateTime)

dateTime

1

Tidspunktet for tilknytningens seneste opdatering

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjektMarkeringerResponse
GetPersonGroupProjectMarkingsResponse

GetPersonGruppeProjektMarkeringerResponseType
GetPersonGroupProjectMarkingsResponseType

1

Svar som indeholder persongruppeprojekttilknytninger.

-    PersonGruppeProjektMarkinger
(PersonGroupProjectMarkings)

PersonGruppeProjektMarkingerDto
(PersonGroupProjectMarkingTypeCollection)

1

En liste af persongruppeprojekttilknytninger

-    -    PersonGruppeProjektMarking
(PersonGroupProjectMarkingType)

PersonGruppeProjektMarkingDto
(PersonGroupProjectMarkingType)

0 - *

-    -    -    MarkeringsIdentifier (PersonGroupMarkingIdentifier)

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

-    -    -    x-civilRegistrationIdentifier (PersonCivilRegistrationIdentifier)

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

CPR-nr på borgeren som er knyttet til persongruppeprojektet.

-    -    -    navnestruktur
(PersonNameStructure)

PersonNameStructureType

1

Indholder detaljer af borgerens navn

-    -    -    -    fornavne
(PersonGivenName)

PersonGivenNameType
Base: string

Length: 1-50

1

Erklæring af personens fornavn(e).

-    -    -    -    mellemnavn
(PersonMiddleName)

PersonMiddleNameType
Base: string

Length: 1-40

0 - 1

Erklæring af personens mellemnavne(e).

-    -    -    -    efternavn
(PersonSurnameName)

PersonSurnameNameType
Base: string

Length: 1-40

1

Erklæring af en persons efternavne(e).

-    -    -    postnummer
(PostCodeIdentifier)

PostCodeIdentifierType
Base: string

Pattern: [0-9]{4}

1

Postnummeret for borgers bopæl

-    -    -    UnemploymentFundInfo

UnemploymentFundInfoType

0 - 1

Borgers aktuelle a-kasse, udfyldes kun ved type 5 projekter

-    -    - akassekode
(UnemploymentFundCode)

int

MinInclusive: 0
MaxInclusive: 99

1

Kode på a-kasse.

-    -    -    -    UnemploymentFundName

string

Length: 1-100

1

Navn på a-kasse.

-    -    -    JobcenterInfo

JobcenterInfoType

1

Borgers aktuelle jobcenter.

-    -    - jobcenterKode (JobcenterIdentifier)

string

Pattern: [0-9]{5}

1

Kode på jobcenter

-    -    -    -    JobcenterName

string

Length: 1-100

1

Navn på jobcenter

-    -    -    ansvarligMyndighed

(ResponsibleAuthority)

AnsvarligMyndighedDto

1

Den myndighed som har oprettet tilknytningen og kan opdatere den

-    -    -    -    organisationKode
(AuthorityCode)

string

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

1

Myndighedskode for ansvarlig myndighed

-    -    -    -    OrganisationType (OrganisationTypeIdentifier)

OrganisationTypeCodeList
OrganisationTypeIdentifierType

1

Myndighedstype, ansvarlig myndighed

-    -    -    -    navn
(UserFullName)

string

Length: 1-140

1

Sagsbehandlers navn aht. kontakt mhp. samarbejde

-    -    -    -    eksterntId
(UserIdentifier)

string

Length: 1-255

1

Sagsbehandlers id

-    -    -    -    email
(UserEmail)

string

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

0 - 1

Sagsbehandlers email aht. kontakt mhp. samarbejde

-    -    -    -    opdateringsTidspunkt (MarkingUpdatedDateTime)

dateTime

1

Tidspunktet for tilknytningens seneste opdatering

...

GetPersonGruppeProjektMarkeringerByCaseWorker (Tidl. GetPersonGroupProjectMarkingsByCaseWorker)

Tilladte organisationer (¤Skal afklares her)

 

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

 

 

 

 

 

 

 

JobCenter

 

 

 

 

 

 

Kommune

 

 

 

 

 

 

 

STAR

 

 

 

 

 

 

 

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjektMarkeringerByCaseWorkerResponse
(GetPersonGroupProjectMarkingsByCaseWorkerResponse)

GetPersonGruppeProjektMarkeringerByCaseWorkerResponseType
GetPersonGroupProjectMarkingsByCaseWorkerResponseType

 

1

Svar som indeholder persongruppeprojekter.

- PersonGruppeProjektMarkinger
CitizenGroupProjectMarkings

PersonGruppeProjektMarkingerDto
(CitizenGroupProjectMarkingsType)

 

0 - 1

Placeholderelement for liste af CitizenGroupProjectMarking objektet.

- -    PersonGruppeProjektMarking
CitizenGroupProjectMarking

PersonGruppeProjektMarkingDto
(CitizenGroupProjectMarkingType)

 

0 - *

Indholder liste af CitizenGroupProjectMarking objektet.

- -    -    MarkeringsIdentifier
(GroupMarkingIdentifier)

guid
Base: string

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

Objekt ID´et for PersonGroupProjectMarking objektet.

- -    -    x-civilRegistrationIdentifier (PersonCivilRegistrationIdentifier)

string

 

1

CPR-nr på borgeren som er knyttet til persongruppemarkeringen.

- -    -    navnestruktur
(PersonNameStructure)

navnestrukturDto
(PersonNameStructureType)

 

1

Indholder detaljer af borgerens navn

- -    -    -    fornavne
(PersonGivenName)

string
(PersonGivenNameType
Base: string)

Length: 1-50

1

Declaration of an individual"s first name(s).

- -    -    -    mellemnavn
(PersonMiddleName)

string
(PersonMiddleNameType
Base: string)

Length: 1-40

0 - 1

Declaration of an individual"s middle name(s).

- -    -    -    efternavn
(PersonSurnameName)

string
(PersonSurnameNameType
Base: string)

Length: 1-40

1

Declaration of an individuals surname.

- -    -    postnummer
(PostCodeIdentifier)

string
(PostCodeIdentifierType
Base: string)

Pattern: [0-9]{4}

1

The postal departments nationwide postal code.

- -    -    opdateringsTidspunkt
(CitizenGroupMarkingTime)

dateTime

 

0 - 1

Tidspunktet for at borgeren er knyttet til persongruppemarkeringen

- -    -    ?
(CitizenGroupMarkingCaseworker)

CitizenGroupMarkingCaseworkerType

 

1

Den caseworker der har knyttet borgeren til persongruppemarkeringen

- -    -    -    sagsbehandlerIdentifier
(RegisteringCaseworkerIdentifier)

string

 

1

Id for sagsbehandleren

- -    -    -    ?
(RegisteringCaseworkerFullName)

string

 

1

Fuldt navn på sagsbehandleren.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

addProjektDeltagendeMyndighederRequest
(AddProjectParticipatingAuthoritiesRequest)

addProjektDeltagendeMyndighederRequestType
(AddProjectParticipatingAuthoritiesRequestType)

1

-    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

Identifikation af persongruppeprojektet.

-    brugerOrganisationer
(ParticipatingAuthorityCollection)

brugerOrganisationerDto
(RequestOrganisationStructureTypeCollection)

1

Liste af myndigheder, der skal tilføjes projektet.

-    -   brugerOrganisation 
(RequestOrganisationStructureType)

brugerOrganisationDto
(RequestOrganisationStructureType)

0 - *

-    -    -    OrganisationType (OrganisationTypeIdentifier)

OrganisationTypeCodeList
(OrganisationTypeIdentifierType)

1

Kodeliste med organisationstype / myndighedstype for registrerende bruger.

-    -    -    Organisationskode
(OrganisationCode)

string
(OrganisationCodeType
Base: string)

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

1

Organisationskode for den registrerende bruger.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

RemoveProjektDeltagendeMyndighederRequest
(RemoveProjectParticipatingAuthorityRequest)

RemoveProjektDeltagendeMyndighederRequestType
(RemoveProjectParticipatingAuthorityRequestTypRemoveProjectParticipatingAuthorityRequestType)e

1

-    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

Identifikation af persongruppeprojektet.

-    myndighed
(Authority)

MyndighedDto
(RequestOrganisationStructureType)

1

Myndighed, der skal fjernes fra projektet.

-    -    OrganisationType (OrganisationTypeIdentifier)

OrganisationTypeCodeList
(OrganisationTypeIdentifierType)

1

Kodeliste med organisationstype / myndighedstype for registrerende bruger.

-    -    Organisationskode
(OrganisationCode)

string
(OrganisationCodeType
Base: string)

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

1

Organisationskode for den registrerende bruger.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

DeletePersonGruppeMarkeringRequest
(DeletePersonGroupMarkingRequest)

DeletePersonGruppeMarkeringRequestType
(DeletePersonGroupMarkingRequestType)

1

- MarkeringsIdentifier
(MessageIdentifier)

guid
Base: string

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.

- berigtigelseskommentar
(CorrectionComment)

Stringstring
(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterByTypeResponse
(GetPersonGroupProjectsByTypeResponse)

GetPersonGruppeProjekterByTypeResponse
(GetPersonGroupProjectsByTypeResponseType)

1

-    personGruppeProjekter
(PersonGroupProjects)

personGruppeProjekterDto
(GetPersonGroupProjectTypeCollection)

1

Placeholder for liste af persongruppeprojekt objekter.

-    -    personGruppeProjekt
(GetPersonGroupProjectType)

personGruppeProjektDto
(GetPersonGroupProjectType)

0 - *

Indholder liste af persongruppeprojekt objekter.

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

Identifikation af persongruppeprojektet.

-    -    -    personGruppeProjekt (PersonGroupProjectItem)

personGruppeProjektDto
(GetPersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    -    -    starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    -    -    sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

-    -    -    -    anvendendeOrganisationstype (PersonGroupProjectTypeIdentifier)

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Projekttypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier

-    -    -    -    projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

-    -    -    -    deltagerIndikatorPåProjektType (ParticipationIndicatedByProjectType)

boolean

1

Indikation på at deltagende myndigheder kun er angivet i kraft af projekttypen, da alle myndigheder deltager i denne projekttype.

-    -    -    -    deltagendeMyndigheder (ParticipatingAuthorities)

deltagendeMyndighederDto
(ParticipatingAuthorityTypeCollection)

1

En liste med deltagende myndigheder (a-kasser og jobcentre). Ved projekter af typen 1 - Stat - jobcentre er listen tom idet feltet deltagerIndikatorPåProjektType (ParticipationIndicatedByProjectType)=true indikerer at alle jobcentre deltager.

-    -    -    -    -    deltagendeMyndighed (ParticipatingAuthorityType)

deltagendeMyndighedDto
(ParticipatingAuthorityType)

0 - *

En deltagende myndighed

-    -    -    -    -    -    organisationKode (AuthorityCode)

string

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

1

Myndighedskode

-    -    -    -    -    -    OrganisationType (OrganisationTypeIdentifier)

OrganisationTypeCodeList
(OrganisationTypeIdentifierType)

1

Myndighedstype

-    -    -    berigtigelseskommentar (CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...