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.

...

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGroupProjectResponse
(GetPersonGroupProjectRequest)

GetPersonGroupProjectResponseType
(GetPersonGroupProjectRequestType)

1

x-civilRegistrationIdentifier [Header]

string

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

1

Beskrivelse af cpr

x-requestId [Header]

string

 

1

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

requestBody

 

 

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 et specifikt persongruppeprojekt.

...

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterRequest
(GetPersonGroupProjectsRequest)

GetPersonGruppeProjekterRequestType)
(GetPersonGroupProjectsRequestType)

1

...

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterForyTypeRequest
(GetPersonGroupProjectsByTypeRequest)

GetPersonGruppeProjekterForTypeRequestType
(GetPersonGroupProjectsByTypeRequestType)

1

  • anvendendeOrganisationstype (PersonGroupProjectTypeIdentifier)

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Projekttypen som man ønsker at hente projekter for

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterForTypeResponse
(GetPersonGroupProjectsByTypeResponse)

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

Fejlkoder

Ingen fejlkoder


CreateProjektdeltagendemyndighed (Tidl. AddProjectParticipatingAuthorities)

Metode til at tilføje myndigheder til et persongruppeprojekt med flere deltagende jobcentre og/eller a-kasser.

...

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

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

...

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppemarkeringerRequest
(GetPersonGroupProjectMarkingsRequest)

GetPersonGruppemarkeringerRequestType
GetPersonGroupProjectMarkingsRequestType

1

Forespørgsel som indeholder data vedr. de persongruppeprojekter der ønskes.

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

  • StartDato

(StartDate)

dateTime

0 - 1

Startdato på ønsket periode for tilknytninger.

  • SlutDato

(EndDate)

dateTime

0 - 1

Slutdato på ønsket periode for tilknytninger.

  • sagsbehandlerIdentifier

(RegisteringCaseworkerIdentifier)

string

0 - 1

Den sagsbehandler som der ønskes persongruppeprojekttilknytninger for.

...

Fejlkode

Fejltekst

Beskrivelse

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

GetPersonGruppeProjektMarkeringerByCaseWorker (Tidl. GetPersonGroupProjectMarkingsByCaseWorker) ¤Udgår

...

GetPersonGruppemarkeringerHistorik ¤ skal laves

Metode til at hente tilknytninger til et projekt, som man som myndighed har adgang til - med mulighed for at indsnævre resultatet til en specifik sagsbehandlers tilknytninger historik.

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

 

Driftsselskab

 

X

 

JobCenter

 

 

 

X

X

Kommune

X

STAR

X

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppemarkeringerRequest
(GetPersonGroupProjectMarkingsRequest)

GetPersonGruppemarkeringerRequestType
GetPersonGroupProjectMarkingsRequestType

1

Forespørgsel som indeholder data vedr. de persongruppeprojekter der ønskes.

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

  • StartDato

(StartDate)

dateTime

0 - 1

Startdato på ønsket periode for tilknytninger.

  • SlutDato

(EndDate)

dateTime

0 - 1

Slutdato på ønsket periode for tilknytninger.

  • sagsbehandlerIdentifier

(RegisteringCaseworkerIdentifier)

string

0 - 1

Den sagsbehandler som der ønskes persongruppeprojekttilknytninger for.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppemarkeringerResponse
(GetPersonGroupProjectMarkingsResponse)

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

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

GetPersonGruppeProjektMarkeringerByCaseWorker (Tidl. GetPersonGroupProjectMarkingsByCaseWorker) ¤Udgår

 

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

 

 

 

 

 

 

 

Scope

borgerkommunikation.read ¤Skal afklares

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjektMarkeringerByCaseWorkerRequest
(GetPersonGroupProjectMarkingsByCaseWorkerRequest)

GetPersonGruppeProjektMarkeringerByCaseWorkerRequestType
GetPersonGroupProjectMarkingsByCaseWorkerRequestType

 

1

Forespørgsel som indeholder data vedr. de persongruppeprojekter der ønskes.

  • projektIdentifier

(PersonGroupProjectIdentifier)

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 persongruppeprojekt objektet.

  • StartDato

(StartDate)

dateTime

 

0 - 1

Startdato på persongruppeprojekt.

  • SlutDato

(EndDate)

dateTime

 

0 - 1

Slutdato på persongruppeprojekt.

  • sagsbehandlerIdentifier

(RegisteringCaseworkerIdentifier)

string

 

0 - 1

Den sagsbehandler som der ønskes persongruppeprojekttilknytninger for.

Output

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.

Fejlkoder

Ingen fejlkoder