Kontaktforloeb.FristService (Version 1, 2024-3)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateFrist (POST /v1/Frist)

Creates a new frist based on the request.

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
JobCenter		X			X
STAR	X

Scope

kontaktforloeb.frist.write

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
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	CreateFristRequestDto		1	DTO for oprettelse af frist
- fristaktiveringsdato	date		0 - 1	Dato for aktivering af fristen. Inden denne dato kan fristen ikke indfries, og borger kan ikke se den. Sættes til oprettelsesdato for fristen hvis intet er angivet
- fristdato	date		1	Fristen for at borger har booket et møde
- samtaleType	SamtaleTypeCodeList		1

Output

Element	Type	Detaljer	Forekomst	Beskrivelse
response	uuid		1

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
4405	Borgeren med det specificerede CPR nummer er død	Borgeren med det specificerede CPR nummer er død
8254	Fristen skal være i fremtiden	Fristen skal være i fremtiden
8255	Fristaktiveringsdatoen skal være i fremtiden	Fristaktiveringsdatoen skal være i fremtiden
8256	Fristen skal være mindst en dag efter fristaktiveringsdatoen	Fristen skal være mindst en dag efter fristaktiveringsdatoen
8257	Der kan kun registreres frist for selvbook for samtaletype 4, 7 og 17 (dog ikke 17 for overgangspersoner)	Der kan kun registreres frist for selvbook for samtaletype 4, 7 og 17 (dog ikke 17 for overgangspersoner)
8301	Fristen kan ikke oprettes på grund af borgers fravær og fritagelser	Fristen kan ikke oprettes på grund af borgers fravær og fritagelser
9216	Borger er dagpengemodtager og kan kun få frist til samtaletype 7 og 17 (dog ikke 17 for overgangspersoner)	Borger er dagpengemodtager og kan kun få frist til samtaletype 7 og 17 (dog ikke 17 for overgangspersoner)
9218	Frist til denne samtaletype er ikke lovlig for denne borgers kontaktgruppe	Frist til denne samtaletype er ikke lovlig for denne borgers kontaktgruppe
9219	Borgeren har en frist med en anden samtaletype som først skal lukkes	Borgeren har en frist med en anden samtaletype som først skal lukkes

GetFrist (GET /v1/Frist)

Gets a list of frister for a given person.

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
JobCenter		X		X	X	X
STAR	X

Scope

kontaktforloeb.frist.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

Output

Element	Type	Detaljer	Forekomst	Beskrivelse
response	GetFristResponseDto		1	DTO for at hente frister
- frister	FristDtoCollection		1	Samling af borgers aktuelle frister
- - FristDto	FristDto		0 - *
- - - fristId	uuid		1	Id for frist
- - - samtaleType	SamtaleTypeCodeList		1
- - - fristaktiveringsdato	date		1	Dato for aktivering af fristen. Inden denne dato kan frist ikke indfries. Hvis ej sat, sættes den til oprettelsesdato for fristen
- - - fristdato	date		1	Fristen for at borger har booket et møde
- - - friststatusType	FriststatusTypeCodeList		1
- - - berigtigelseskommentar	string	Length: 1-1500	0 - 1	Kommentar til berigtigelse af en registrering
- - - dFDGRegistreringstidspunkt	date-time		1	Hændelsesdato for registreringen

Fejlkoder

Ingen fejlkoder

CreateFrist (POST /v1/Frist/{fristId})

Creates a new frist with the given Id based on the request.

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
JobCenter		X			X
STAR	X

Scope

kontaktforloeb.frist.write

Input

Element	Type	Detaljer	Forekomst	Beskrivelse
fristId [Path]	uuid		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	CreateFristRequestDto		1	DTO for oprettelse af frist
- fristaktiveringsdato	date		0 - 1	Dato for aktivering af fristen. Inden denne dato kan fristen ikke indfries, og borger kan ikke se den. Sættes til oprettelsesdato for fristen hvis intet er angivet
- fristdato	date		1	Fristen for at borger har booket et møde
- samtaleType	SamtaleTypeCodeList		1

Output

Element	Type	Detaljer	Forekomst	Beskrivelse
response	uuid		1

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
4405	Borgeren med det specificerede CPR nummer er død	Borgeren med det specificerede CPR nummer er død
8254	Fristen skal være i fremtiden	Fristen skal være i fremtiden
8255	Fristaktiveringsdatoen skal være i fremtiden	Fristaktiveringsdatoen skal være i fremtiden
8256	Fristen skal være mindst en dag efter fristaktiveringsdatoen	Fristen skal være mindst en dag efter fristaktiveringsdatoen
8257	Der kan kun registreres frist for selvbook for samtaletype 4, 7 og 17 (dog ikke 17 for overgangspersoner)	Der kan kun registreres frist for selvbook for samtaletype 4, 7 og 17 (dog ikke 17 for overgangspersoner)
8301	Fristen kan ikke oprettes på grund af borgers fravær og fritagelser	Fristen kan ikke oprettes på grund af borgers fravær og fritagelser
9216	Borger er dagpengemodtager og kan kun få frist til samtaletype 7 og 17 (dog ikke 17 for overgangspersoner)	Borger er dagpengemodtager og kan kun få frist til samtaletype 7 og 17 (dog ikke 17 for overgangspersoner)
9218	Frist til denne samtaletype er ikke lovlig for denne borgers kontaktgruppe	Frist til denne samtaletype er ikke lovlig for denne borgers kontaktgruppe
9219	Borgeren har en frist med en anden samtaletype som først skal lukkes	Borgeren har en frist med en anden samtaletype som først skal lukkes

UpdateFrist (PUT /v1/Frist/{fristId})

Updates a frist with the given Id based on the request.

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
JobCenter		X			X
STAR	X

Scope

kontaktforloeb.frist.write

Input

Element	Type	Detaljer	Forekomst	Beskrivelse
fristId [Path]	uuid		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	UpdateFristRequestDto		1	DTO for opdatering af frist
- fristaktiveringsdato	date		0 - 1	Dato for aktivering af fristen. Inden denne dato kan fristen ikke indfries, og borger kan ikke se den. Sættes til oprettelsesdato for fristen hvis intet er angivet
- fristdato	date		0 - 1	Fristen for at borger har booket et møde
- friststatusType	FriststatusTypeCodeList		0 - 1
- berigtigelseskommentar	string	Length: 1-1500	0 - 1	Kommentar om årsagen når frist nedlægges

Output

Intet output

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
8254	Fristen skal være i fremtiden	Fristen skal være i fremtiden
8255	Fristaktiveringsdatoen skal være i fremtiden	Fristaktiveringsdatoen skal være i fremtiden
8256	Fristen skal være mindst en dag efter fristaktiveringsdatoen	Fristen skal være mindst en dag efter fristaktiveringsdatoen
8258	Fristen er lukket og kan ikke opdateres	Fristen er lukket og kan ikke opdateres
8259	Den angivne frist findes ikke i systemet	Den angivne frist findes ikke i systemet
8262	Friststatus kan kun opdateres til status id 4 eller 5	Friststatus kan kun opdateres til status id 4 eller 5
8263	Fristen kan kun sættes til status id 5 hvis den er i status id 2	Fristen kan kun sættes til status id 5 hvis den er i status id 2
8265	Frist må ikke ligge tidligere end en foregående fristindfriende booking	Frist må ikke ligge tidligere end en foregående fristindfriende booking
8266	Fristaktiveringsdato kan kun opdateres når fristen ikke er aktiveret	Fristaktiveringsdato kan kun opdateres når fristen ikke er aktiveret
8267	Enten fristaktiveringsdato, fristdato eller friststatus skal sættes	Enten fristaktiveringsdato, fristdato eller friststatus skal sættes
8290	Berigtigelseskommentar skal påføres når fristen lukkes	Berigtigelseskommentar skal påføres når fristen lukkes

GetFrist (GET /v1/Frist/{fristId})

Gets a frist with the given Id on the provided person.

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
JobCenter		X		X	X	X
STAR	X

Scope

kontaktforloeb.frist.read

Input

Element	Type	Detaljer	Forekomst	Beskrivelse
fristId [Path]	uuid		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

Output

Element	Type	Detaljer	Forekomst	Beskrivelse
response	GetFristResponseDto		1	DTO for at hente frister
- frister	FristDtoCollection		1	Samling af borgers aktuelle frister
- - FristDto	FristDto		0 - *
- - - fristId	uuid		1	Id for frist
- - - samtaleType	SamtaleTypeCodeList		1
- - - fristaktiveringsdato	date		1	Dato for aktivering af fristen. Inden denne dato kan frist ikke indfries. Hvis ej sat, sættes den til oprettelsesdato for fristen
- - - fristdato	date		1	Fristen for at borger har booket et møde
- - - friststatusType	FriststatusTypeCodeList		1
- - - berigtigelseskommentar	string	Length: 1-1500	0 - 1	Kommentar til berigtigelse af en registrering
- - - dFDGRegistreringstidspunkt	date-time		1	Hændelsesdato for registreringen

Fejlkoder

Ingen fejlkoder

GetFristhistorik (GET /v1/Frist/historik)

Gets the deadline history for a given person.

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
JobCenter		X		X	X	X
STAR	X

Scope

kontaktforloeb.frist.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

Output

Element	Type	Detaljer	Forekomst	Beskrivelse
response	GetFristhistorikResponseDto		1	DTO for svar på hentning af fristhistorik.
- frister	FristhistorikDtoCollection		1	Liste af historik om frister.
- - FristhistorikDto	FristhistorikDto		0 - *
- - - registreringsmetadata	RegistreringsmetadataDto		1	DTO for registreringsmetadata.
- - - - erSlettet	boolean		1	Angiver om registreringen er en sletning
- - - - erAktuel	boolean		1	Det er en række som er aktuel (kan typisk også ses i PSS).
- - - - registrerendeMyndighed	RegistrerendeMyndighedDto		0 - 1	DTO for registrerende myndighed.
- - - - - organisationType	OrganisationTypeCodeList		1
- - - - - organisationskode	string	Length: 1-20	1	Identifikation af organisation / myndighed
- - - - - registrerendeBruger	RegistrerendeBrugerDto		0 - 1	DTO for registrerende bruger.
- - - - - - kaldendeBruger	KaldendeBrugerDto		1	DTO for kaldende bruger.
- - - - - - - brugerFuldtNavn	string	Length: 1-140	1	Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.
- - - - - - - brugerType	RequestUserTypeCodeList		1
- - - - - - - brugerId	string	Length: 1-255	1	Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.
- - - - - - - brugerEmail	email		0 - 1	Brugers e-mail.
- - - - - - brugerOrganisation	BrugerOrganisationDto		1	DTO for brugerorganisation.
- - - - - - - organisationType	OrganisationTypeCodeList		1
- - - - - - - organisattionskode	string	Pattern: [-][1]\|[0-9]{1,8} MinLength: 1	1	Organisationskode for den registrerende bruger.
- - - - - - dfdgRegistreringstidspunkt	date-time		1	Tidspunkt for registrering i DFDG
- - - fristId	uuid		1	Id for frist.
- - - samtaleType	SamtaleTypeCodeList		1
- - - fristaktiveringsdato	date-time		1	Dato for aktivering af fristen. Inden denne dato kan frist ikke indfries. Hvis ej sat, sættes den til oprettelsesdato for fristen.
- - - fristdato	date-time		1	Frist for hvornår der senest skal foretages en booking
- - - friststatusType	FriststatusTypeCodeList		1
- - - berigtigelseskommentar	string	Length: 0-1500	0 - 1	Kommentar til berigtigelse af en registrering.

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
1	Person does not exist for given cpr number.	Person does not exist for given cpr number.

Kontaktforloeb.FristService (Version 1, 2024-3)

Metoder

CreateFrist (POST /v1/Frist)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetFrist (GET /v1/Frist)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

CreateFrist (POST /v1/Frist/{fristId})

Tilladte organisationer

Scope

Input

Output

Fejlkoder

UpdateFrist (PUT /v1/Frist/{fristId})

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetFrist (GET /v1/Frist/{fristId})

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetFristhistorik (GET /v1/Frist/historik)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

Tilgængelighed: https://starwiki.atlassian.net/was