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.

...

Denne metode gør det muligt at oprette et persongruppeprojekt.

Tilladte

...

organisation

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.PersonGroupProjectService.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

CreatePersonGroupProjectRequest

CreatePersonGroupProjectRequestType

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

 

-    personGruppeProjekt
(PersonGroupProjectItem)

PersonGruppeProjektDto
(PersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

- -    anvendendeOrganisationstype
(PersonGroupProjectTypeIdentifier)

OrganisationTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

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

-    -    projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

...

Denne metode gør det muligt at opdatere et registreret persongruppeprojekt. Det er kun muligt at ændre på startdatoen frem i tiden. En slutdato betyder, at det ikke længere er muligt at tilknytte personer til projektet. Der sættes ikke en slutdato på eksisterende persongruppemarkeringer.

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.PersonGroupProjectService.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

UpdatePersonGroupProjectRequest

UpdatePersonGroupProjectRequestType

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

 

-    PersonGroupProject

PersonGroupProjectType

1

Indeholder information om en given persongruppe.

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

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

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

-    - projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

- berigtigelseskommentar
(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

Denne metode gør det muligt at slette et persongruppeprojekt.

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.PersonGroupProjectService.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

DeletePersonGroupProjectRequest

DeletePersonGroupProjectRequestType

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

-    berigtigelseskommentar
(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

Metode til at hente et specifikt persongruppeprojekt.

Tilladte organisationer

Driftsselskab

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

X

JobCenter

X

X

Kommune

X

STAR

X

Scope

borgerkommunikation.PersonGroupProjectService.read

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.

...

Metode til at hente persongruppeprojekter.

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.PersonGroupProjectService.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterRequest
(GetPersonGroupProjectsRequest)

GetPersonGruppeProjekterRequestType)
(GetPersonGroupProjectsRequestType)

1

...

Metode til at hente persongruppeprojekter af en specifik type

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.PersonGroupProjectService.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGruppeProjekterForyTypeRequest
(GetPersonGroupProjectsByTypeRequest)

GetPersonGruppeProjekterForTypeRequestType
(GetPersonGroupProjectsByTypeRequestType)

1

  • anvendendeOrganisationstype (PersonGroupProjectTypeIdentifier)

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Projekttypen som man ønsker at hente projekter for

...

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

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

STAR

X

Scope

borgerkommunikation.PersonGroupProjectService.staronly.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateProjektdeltagendemyndighedRequest
(AddProjectParticipatingAuthoritiesRequest)

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

...

Metode til at fjerne myndigheder fra et tværgående persongruppeprojekter. Metoden kan kun kaldes af STAR.

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

STAR

X

Scope

borgerkommunikation.PersonGroupProjectService.staronly.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

DeleteProjektdeltagendemyndighedRequest
(RemoveProjectParticipatingAuthorityRequest)

DeleteProjektdeltagendemyndighedRequestType
(RemoveProjectParticipatingAuthorityRequestType)

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.

...

Denne servicemetode benyttes til at oprette en persongruppemarkering

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

JobCenter

X

X

Kommune

X

STAR

X

Scope

borgerkommunikation.PersonGruppeMarkeringPersonGroupProjectService.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

CreatePersonGruppeMarkering
(CreatePersonGroupMarkingRequest)

CreatePersonGruppeMarkeringType
(CreatePersonGroupMarkingRequestType)

1

- PersonGruppeMarking
(PersonGroupMarking)

PersonGruppeMarkingDto
(PersonGroupMarkingType)

1

- -    x-civilRegistrationIdentifier (PersonCivilRegistrationIdentifier)

x-civilRegistrationIdentifier (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

Beskrivelse af cpr

- -    starttidspunkt
(PersonGroupMarkingStartTime)

dateTime

1

Startdato og tidspunkt.

- -    sluttidspunkt
(PersonGroupMarkingEndTime)

dateTime

0 - 1

Slutdato og tidspunkt.

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

Guid tilknytning til et oprettet persongruppeprojekt

...

Denne servicemetode benyttes til at opdatere en persongruppemarkering.

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

JobCenter

X

X

Kommune

X

STAR

X

Scope

borgerkommunikation.PersonGruppeMarkeringPersonGroupProjectService.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

UpdatePersonGruppeMarkeringRequest
(UpdatePersonGroupMarkingRequest)

UpdatePersonGruppeMarkeringRequestType
(UpdatePersonGroupMarkingRequestType)

1

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

- sluttidspunkt
(PersonGroupMarkingStartTime)

dateTime

1

Startdato og tidspunkt.

- sluttidspunkt
(PersonGroupMarkingEndTime)

dateTime

0 - 1

Slutdato og tidspunkt.

- berigtigelseskommentar
(CorrectionComment)

String
(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

Denne servicemetode benyttes til at slette en persongruppemarkering.

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

JobCenter

X

X

Kommune

X

STAR

X

Scope

borgerkommunikation.PersonGruppeMarkeringPersonGroupProjectService.write

Input

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)

string
(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

Metoden bruges til at hente en specifik persongruppetilknytning.

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.PersonGroupProjectService.read

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

...

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.

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.PersonGroupProjectService.read

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.

...

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.PersonGroupProjectService.read

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.

...

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.PersonGroupProjectService.read ¤Skal afklares

Input

...