MinUddannelse Api

GetKuiPlanRequest

Data from a "KUI uddannelsesplan"

**Requires Authentication**
Required role:	NovaLink	Requires any of the roles:	NovaLink, Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi

The following routes are available for this service:
GET	/novalink/kuiplan

**GetKuiPlanResponse** Parameters:
Name	Parameter	Data Type	Required
Person	form	PersonContactDto	No
Contact	form	ContactDto	No
KuiContact	form	ContactDto	No
Parents	form	List<ParentContactDto>	No
KuiPlan	form	KuiPlanDto	No

**PersonContactDto** Parameters:
Name	Parameter	Data Type	Required	Description
Address	form	AddressDto	No
IsAuthoritative	form	bool?	No

**ContactDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Cpr	form	string	No
Name	form	string	No
Title	form	string	No
Email	form	string	No
Phone	form	string	No
Location	form	string	No
Category	form	string	No

**AddressDto** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	No
Postalcode	form	string	No
City	form	string	No

**KuiPlanDto** Parameters:
Name	Parameter	Data Type	Required	Description
Betegnelse	form	string	No	Header name of the plan
Situation	form	SituationDto	No	Data from the Situation tab
Afdaekning	form	AfdaekningDto	No	Data from the Afdækning tab
Handling	form	NaesteSkridtDto	No	Data from the Næste skridt tab
Godkendelser	form	List<GodkendelseDto>	No	Approvals from parents or pupil
GodkendelsesStatus	form	string	No	Lastest approval status

**SituationDto** Parameters:
Name	Parameter	Data Type	Required	Description
Livssituation	form	string	No	Data from the field "Livssituation"
Stoettebehov	form	bool	No	Data from the field "Behov for socialpædagogisk støtte (SPS)"
StoettebehovBeskrivelse	form	string	No	Data from the field "Hvilken SPS støtte er der behov for?"
Ordblindeundervisning	form	bool	No	Data from the field "Behov for ordblindeundervisning"
OrdblindeundervisningBeskrivelse	form	string	No	Data from the field "Beskrivelse af ordblindeundervisning"
Behandlingsforloeb	form	bool	No	Data from the field "Evt behandlingsforløb den unge deltager i"
BehandlingsforloebBeskrivelse	form	string	No	Data from the field "Beskriv hvilket behandlingsforløb"
NedsatTid	form	bool	No	Data from the field "FGU på nedsat tid, eller anden særlig aftale med KUI"
Beskrivelse	form	string	No	Data from the field "Beskriv aftalen"
Temaer	form	List<TemaDto>	No	Data from the section "Temaer"
Kommentar	form	string	No	Data from the field "Kommentar til livssituation"
AndenAftaleOmSaerligeHensyn	form	bool	No	Data from the field "Anden aftale med KUI omkring støtte eller særlige hensyn"
AndenAftaleOmSaerligeHensynBeskrivelse	form	string	No	Data from the field "Anden aftale med KUI omkring støtte eller særlige hensyn"
IkkeBehovSaerligeHensyn	form	bool	No	Data from the field "Der er ikke behov for støtte eller særlige hensyn"
Besvarelser	form	IEnumerable<AfsnitDto>	No	Answers from pupil

**TemaDto** Parameters:
Name	Parameter	Data Type	Required
Titel	form	string	No
SystemNavn	form	string	No
Indhold	form	string	No

**AfsnitDto** Parameters:
Name	Parameter	Data Type	Required
Noegle	form	string	No
Titel	form	string	No
Felter	form	IEnumerable<FeltDto>	No

**FeltDto** Parameters:
Name	Parameter	Data Type	Required
Noegle	form	string	No
Titel	form	string	No
Indhold	form	string	No
Opdateret	form	DateTime	No

**AfdaekningDto** Parameters:
Name	Parameter	Data Type	Required	Description
Uddannelsesoenske	form	string	No	Data from the field "Den unges uddannelsesønske"
Joboenske	form	string	No	Data from the field "Den unges jobønske"
Praesentation	form	string	No	Data from the field "Præsentation af den unge"
Kompetencer	form	string	No	Data from the field "Kompetencer"
UnguddForudsaetning	form	bool?	No	Data from the field "Ingen umiddelbare forudsætninger for at gennemføre en ungdomsuddannelse"
FguMaalgruppeUngUnder25	form	bool?	No	Indicates whether or not the person is under 25 years old
FguMaalgruppeHarIkkeUngdomsuddannelse	form	bool?	No	True if the person has NOT completed an upper secondary education (youth education)
FguMaalgruppe	form	bool?	No	Data from the field "Den unge vurderes at tilhøre målgruppen"
FguVurderingsKommentar	form	string	No	Data from the field "Beskriv hvorfor den unge ikke tilhører målgruppen"
Kommentar	form	string	No	Data from the field "Kommentar til afdækning"
Motivation	form	AfdaekningMotivationDto	No	Data from the section "Motivation og kompetencer"
Besvarelser	form	IEnumerable<AfsnitDto>	No	Answers from pupil

**AfdaekningMotivationDto** Parameters:
Name	Parameter	Data Type	Required	Description
FagligMotivation	form	string	No	Data from the field "Faglig motivation"
PersonligMotivation	form	string	No	Data from the field "Personlig motivation"
SocialMotivation	form	string	No	Data from the field "Social motivation"

**NaesteSkridtDto** Parameters:
Name	Parameter	Data Type	Required	Description
NaesteTrin	form	string	No	Textual representation of the field "Næste skridt". One of: FGU, Ungdomsuddannelse, Arbejde, Andet
Aktivitet	form	AktivitetDto	No	Selected activity in "Næste skridt"
Besvarelser	form	IEnumerable<AfsnitDto>	No	Answers from pupil

**AktivitetDto** Parameters:
Name	Parameter	Data Type	Required	Description
Fgu	form	FguaktivitetDto	No	Has a value if "Forberedende grunduddannelse (FGU)" is selected
Ungdomsuddannelse	form	UngdomsuddannelseAktivitetDto	No	Has a value if "Ungdomsuddannelse" is selected
Arbejde	form	ArbejdeDto	No	Has a value if "Et arbejde" is selected
Andet	form	AndetDto	No	Has a value if "Andet" is selected
Tiende	form	TiendeDto	No	Has a value if "10. klasse" is selected

**FguaktivitetDto** Parameters:
Name	Parameter	Data Type	Required	Description
Basisforloeb	form	FguForloebDto	No
Afsoegningsforloeb	form	FguForloebDto	No
Uddannelse	form	FguUddannelseDto	No	Data from the section "Forberedende grunduddannelse (FGU)"
Uddannelsessted	form	UddannelsesstedDto	No	Data from the section "FGU uddannelsessted"
PersonligeMaal	form	string	No	Data from the field "Personlige mål"
SocialeMaal	form	string	No	Data from the field "Sociale mål"
FagligeMaal	form	string	No	Data from the field "Faglige mål"
PraktiskeMaal	form	string	No	Data from the field "Praktiske mål"
Samtykke	form	bool	No	Data from the field "Der er samtykke til at dele uddannelsesplanen med FGU institution"
SamtykkeVedUdskrift	form	bool	No	Data from the field "Samtykke til at dele uddannelsesplanen med FGU institutionen gives ved underskrift af udannelsesplanen"
Periode	form	PeriodeDto	No
Kommentar	form	string	No
PguOenske1	form	string	No
PguOenske2	form	string	No
PguKommentar	form	string	No

**FguForloebDto** Parameters:
Name	Parameter	Data Type	Required
Valgt	form	bool	No
Uddannelsessted	form	UddannelsesstedDto	No
Periode	form	PeriodeDto	No
Kommentar	form	string	No

**UddannelsesstedDto** Parameters:
Name	Parameter	Data Type	Required	Description
Institutionskode	form	string	No	"Institutionskode" of the selected educational institution
Navn	form	string	No	Name of the selected educational institution
Cvr	form	string	No	CVR number of the selected educational institution
Pnr	form	string	No	P-number of the selected educational institution
Adresse	form	string	No	Address of the selected educational institution
Postnummer	form	string	No	Postal code of the selected educational institution
By	form	string	No	City of the selected educational institution

**PeriodeDto** Parameters:
Name	Parameter	Data Type	Required	Description
From	form	DateTime?	No
To	form	DateTime?	No

**FguUddannelseDto** Parameters:
Name	Parameter	Data Type	Required	Description
Skoleperiode	form	string	No	Data from the field "Afsøgningsforløb". "AF" if selected
Speciale	form	string	No	Data from the field "Ønske om uddannelsesspor". One of 1, 2, 3, and ?
PguTema	form	string	No
UddannelsessporKommentar	form	string	No

**UddannelseDto** Parameters:
Name	Parameter	Data Type	Required	Description
CosaFormaal	form	string	No
Betegnelse	form	string	No

**UngdomsuddannelseAktivitetDto** Parameters:
Name	Parameter	Data Type	Required	Description
Ungdomsuddannelse	form	UngdomsuddannelseDto	No	Selected education
Periode	form	PeriodeDto	No	Education period
Kommentar	form	string	No
Samtykke	form	bool	No	Data from the field "Der er samtykke til at dele uddannelsesplanen med FGU institution"
SamtykkeVedUdskrift	form	bool	No	Data from the field "Samtykke til at dele uddannelsesplanen med FGU institutionen gives ved underskrift af udannelsesplanen"
EuxTilvalgt	form	bool?	No

**ArbejdeDto** Parameters:
Name	Parameter	Data Type	Required	Description
Hvad	form	string	No	Data from the field "Hvad vil den unge arbejde med?"
Hvordan	form	string	No	Data from the field "Den unges plan for at få et arbejde på det område"
Aftale	form	string	No	Data from the field "Aftale om næste trin"
Periode	form	PeriodeDto	No	Data from the field "Periode for aftalen"
Kommentar	form	string	No	Data from the field "Kommentar til ønske om arbejde"
Samtykke	form	bool	No	Data from the field "Der er samtykke til at dele uddannelsesplanen med FGU institution"
SamtykkeVedUdskrift	form	bool	No	Data from the field "Samtykke til at dele uddannelsesplanen med FGU institutionen gives ved underskrift af udannelsesplanen"

**AndetDto** Parameters:
Name	Parameter	Data Type	Required	Description
Beskrivelse	form	string	No	Data from the field "Hvilket andet næste skridt er aftalt"
Periode	form	PeriodeDto	No
Kommentar	form	string	No
Uddannelsessted	form	UddannelsesstedDto	No

**TiendeDto** Parameters:
Name	Parameter	Data Type	Required	Description
Valgt	form	bool	No
Maal	form	string	No
Uddannelsessted	form	UddannelsesstedDto	No
Periode	form	PeriodeDto	No
Kommentar	form	string	No
Samtykke	form	bool	No	Data from the field "Der er samtykke til at dele uddannelsesplanen med uddannelsesstedet"
SamtykkeVedUdskrift	form	bool	No	Data from the field "Samtykke til at dele uddannelsesplanen med uddannelsesinstitutionen gives ved underskrift af uddannelsesplanen"

**GodkendelseDto** Parameters:
Name	Parameter	Data Type	Required
Tidspunkt	form	DateTime	No
GodkenderNavn	form	string	No
GodkenderRelation	form	string	No
ManuelGodkendelse	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /novalink/kuiplan HTTP/1.1 
Host: api.minuddannelse.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	person: 
	{
		address: 
		{
			street: String,
			postalcode: String,
			city: String
		},
		isAuthoritative: False,
		id: 0,
		cpr: String,
		name: String,
		title: String,
		email: String,
		phone: String,
		location: String,
		category: String
	},
	contact: 
	{
		id: 0,
		cpr: String,
		name: String,
		title: String,
		email: String,
		phone: String,
		location: String,
		category: String
	},
	kuiContact: 
	{
		id: 0,
		cpr: String,
		name: String,
		title: String,
		email: String,
		phone: String,
		location: String,
		category: String
	},
	parents: 
	[
		{
			id: 0,
			cpr: String,
			name: String,
			title: String,
			email: String,
			phone: String,
			location: String,
			category: String
		}
	],
	kuiPlan: 
	{
		KuiplanHeader: String,
		Situation: 
		{
			LifeSituation: String,
			SocialSupportNeeds: False,
			SocialSupportNeedsDescription: String,
			DyslexicSupport: False,
			DyslexicSupportDescription: String,
			Treatment: False,
			TreatmentDescription: String,
			FguDownsizedTime: False,
			FguDownsizedTimeDescription: String,
			Themes: 
			[
				{
					Title: String,
					SystemName: String,
					Content: String
				}
			],
			Comment: String,
			AgreementSpecialConsiderations: False,
			AgreementSpecialConsiderationsDescription: String,
			NoNeedSpecialConsiderations: False
		},
		Covering: 
		{
			EducationalWish: String,
			JobWish: String,
			Presentation: String,
			Competences: String,
			NoYouthEducationPrerequisites: False,
			FguTargetGroupIsUnder25: False,
			FguTargetGroupNoSecondaryEducation: False,
			FguTargetGroup: False,
			FguTargetGroupComment: String,
			Comment: String,
			Motivation: 
			{
				ProfessionalMotivation: String,
				PersonalMotivation: String,
				SocialMotivation: String
			}
		},
		NextStep: 
		{
			NextStep: String,
			Activity: 
			{
				Preparatory: 
				{
					FguBasisCourse: 
					{
						Chosen: False,
						EducationalInstitution: 
						{
							InstitutionCode: String,
							InstitutionName: String,
							CvrNumber: String,
							PNumber: String,
							Address: String,
							PostalCode: String,
							City: String
						},
						Period: 
						{
							From: 0001-01-01,
							To: 0001-01-01
						},
						Comment: String
					},
					FguClarificationCourse: 
					{
						Chosen: False,
						EducationalInstitution: 
						{
							InstitutionCode: String,
							InstitutionName: String,
							CvrNumber: String,
							PNumber: String,
							Address: String,
							PostalCode: String,
							City: String
						},
						Period: 
						{
							From: 0001-01-01,
							To: 0001-01-01
						},
						Comment: String
					},
					Education: 
					{
						SchoolPeriod: String,
						Speciality: String,
						PguTheme: String,
						SpecialityComment: String,
						CosaFormaal: String,
						Description: String
					},
					EducationalInstitution: 
					{
						InstitutionCode: String,
						InstitutionName: String,
						CvrNumber: String,
						PNumber: String,
						Address: String,
						PostalCode: String,
						City: String
					},
					PersonalGoal: String,
					SocialGoal: String,
					ProfesionalGoal: String,
					PrakticalGoal: String,
					ConsentGivenForPlaceOfEducation: False,
					ConsentForPlaceOfEducationGivenBySignature: False,
					Period: 
					{
						From: 0001-01-01,
						To: 0001-01-01
					},
					Comment: String,
					PguWish1: String,
					PguWish2: String,
					PguComment: String
				},
				Secondary: 
				{
					Education: 
					{
						CosaFormaal: String,
						Description: String
					},
					Period: 
					{
						From: 0001-01-01,
						To: 0001-01-01
					},
					Comment: String,
					ConsentGivenForPlaceOfEducation: False,
					ConsentForPlaceOfEducationGivenBySignature: False,
					EuxSelected: False
				},
				Job: 
				{
					WhatToDo: String,
					HowToDo: String,
					Agreement: String,
					Period: 
					{
						From: 0001-01-01,
						To: 0001-01-01
					},
					Comment: String,
					ConsentGivenForPlaceOfEducation: False,
					ConsentForPlaceOfEducationGivenBySignature: False
				},
				Other: 
				{
					Description: String,
					Period: 
					{
						From: 0001-01-01,
						To: 0001-01-01
					},
					Comment: String,
					EducationalInstitution: 
					{
						InstitutionCode: String,
						InstitutionName: String,
						CvrNumber: String,
						PNumber: String,
						Address: String,
						PostalCode: String,
						City: String
					}
				},
				TenthGrade: 
				{
					Chosen: False,
					Goal: String,
					EducationalInstitution: 
					{
						InstitutionCode: String,
						InstitutionName: String,
						CvrNumber: String,
						PNumber: String,
						Address: String,
						PostalCode: String,
						City: String
					},
					Period: 
					{
						From: 0001-01-01,
						To: 0001-01-01
					},
					Comment: String,
					ConsentGivenForPlaceOfEducation: False,
					ConsentForPlaceOfEducationGivenBySignature: False
				}
			}
		},
		Approvals: 
		[
			{
				Timestamp: 0001-01-01,
				PersonName: String,
				PersonRole: String,
				ManualApproval: False
			}
		],
		ApprovalStatus: String
	}
}