MinUddannelse Api

GetKuiEducationInfoRequest

Additional KUI info regarding education

**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/kuieducationinfo

**GetKuiEducationInfoResponse** Parameters:
Name	Parameter	Data Type	Required
EducationOrder	form	EducationOrderDto	No
TaxInformationList	form	List<TaxDto>	No
GuidanceEffort	form	GuidanceEffortDto	No
EducationalWish	form	WishDto	No
JobWish	form	WishDto	No
KuiContact	form	KuiContactDto	No
EducationRecords	form	List<EducationRecordDto>	No
RiskOfCancelling	form	RiskOfCancellingDto	No
Absence	form	AbsenceDto	No
Grades	form	List<GradeDto>	No

**EducationOrderDto** Parameters:
Name	Parameter	Data Type	Required
Step	form	string	No
Start	form	DateTime?	No
JobCenterNumber	form	string	No
JobCenterName	form	string	No
JobCenterPhone	form	string	No
DateResponsabilityStop	form	DateTime?	No
CauseOfInterruption	form	string	No

**TaxDto** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
RegistrationDate	form	DateTime	No
Text	form	string	No

**GuidanceEffortDto** Parameters:
Name	Parameter	Data Type	Required
ClassLevel	form	int?	No
Status	form	string	No
Eud	form	AssessmentDto	No
Gym	form	AssessmentDto	No
Hf	form	AssessmentDto	No

**AssessmentDto** Parameters:
Name	Parameter	Data Type	Required	Description
CurrentResult	form	string	No
Interested	form	bool	No

**WishDto** Parameters:
Name	Parameter	Data Type	Required	Description
RegistrationTime	form	DateTime?	No
Wish	form	string	No

**KuiContactDto** Parameters:
Name	Parameter	Data Type	Required	Description
RegistrationTime	form	DateTime?	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

**EducationRecordDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Title	form	string	No
Location	form	string	No
StartDate	form	DateTime	No
EndDate	form	DateTime?	No
Status	form	string	No
Active	form	bool	No
Note	form	string	No
RiscOfCancelling	form	RiskOfCancellingDto	No
CauseOfCancelling	form	string	No

**RiskOfCancellingDto** Parameters:
Name	Parameter	Data Type	Required
RegistrationDate	form	DateTime	No
ProcessDate	form	DateTime?	No
DissmissDate	form	DateTime?	No
Institution	form	InstitutionInformationDto	No
Activity	form	string	No

**InstitutionInformationDto** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
ContactInformation	form	string	No

**AbsenceDto** Parameters:
Name	Parameter	Data Type	Required
PeriodeTyper	form	List<string>	No
FravaerPerioder	form	List<AbsencePeriodeDto>	No
Institutioner	form	List<AbsenceInstitutionDto>	No

**AbsencePeriodeDto** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	DateTime	No
Fravaer	form	List<AbsenceRegistrationDto>	No

**AbsenceRegistrationDto** Parameters:
Name	Parameter	Data Type	Required
FravaerType	form	string	No
Value	form	int	No
Partiel	form	bool	No
InstitutionsKode	form	int	No

**AbsenceInstitutionDto** Parameters:
Name	Parameter	Data Type	Required
Kode	form	int	No
Navn	form	string	No
Type	form	string	No

**GradeDto** Parameters:
Name	Parameter	Data Type	Required	Description
Navn	form	string	No	Name of grade
Skoleaar	form	int	No	Starting year of this stage of education
Klassetrin	form	int	No	Stage of education 0-11
Skala	form	int	No	Type of assesment system
Foerste	form	string	No	First continuous assessment mark
Anden	form	string	No	Second continuous assessment mark
Tredje	form	string	No	Third continuous assessment mark
Proeve	form	string	No	Result of exam
Disciplin	form	string	No	Name of disciplin
Institutionsnavn	form	string	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/kuieducationinfo HTTP/1.1 
Host: api.minuddannelse.net 
Accept: text/jsv

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

{
	educationOrder: 
	{
		step: String,
		start: 0001-01-01,
		jobCenterNumber: String,
		jobCenterName: String,
		jobCenterPhone: String,
		dateResponsabilityStop: 0001-01-01,
		causeOfInterruption: String
	},
	taxInformationList: 
	[
		{
			type: String,
			registrationDate: 0001-01-01,
			text: String
		}
	],
	guidanceEffort: 
	{
		classLevel: 0,
		status: String,
		eud: 
		{
			currentResult: String,
			interested: False
		},
		gym: 
		{
			currentResult: String,
			interested: False
		},
		hf: 
		{
			currentResult: String,
			interested: False
		}
	},
	educationalWish: 
	{
		registrationTime: 0001-01-01,
		wish: String
	},
	jobWish: 
	{
		registrationTime: 0001-01-01,
		wish: String
	},
	kuiContact: 
	{
		registrationTime: 0001-01-01,
		id: 0,
		cpr: String,
		name: String,
		title: String,
		email: String,
		phone: String,
		location: String,
		category: String
	},
	educationRecords: 
	[
		{
			id: 0,
			title: String,
			location: String,
			startDate: 0001-01-01,
			endDate: 0001-01-01,
			status: String,
			active: False,
			note: String,
			riscOfCancelling: 
			{
				registrationDate: 0001-01-01,
				processDate: 0001-01-01,
				dissmissDate: 0001-01-01,
				institution: 
				{
					name: String,
					contactInformation: String
				},
				activity: String
			}
		}
	],
	riskOfCancelling: 
	{
		registrationDate: 0001-01-01,
		processDate: 0001-01-01,
		dissmissDate: 0001-01-01,
		institution: 
		{
			name: String,
			contactInformation: String
		},
		activity: String
	},
	absence: 
	{
		TypeOfPeriods: 
		[
			String
		],
		PeriodOfAbsence: 
		[
			{
				start: 0001-01-01,
				AbsenceRegistration: 
				[
					{
						AbsenceType: String,
						value: 0,
						partiel: False,
						InstitutionCode: 0
					}
				]
			}
		],
		Institutions: 
		[
			{
				InstitutionCode: 0,
				InstitutionName: String,
				InstitutionType: String
			}
		]
	},
	grades: 
	[
		{
			Name: String,
			YearOfEducation: 0,
			Class: 0,
			AssesmentScale: 0,
			FirstAssesmentMark: String,
			SecondAssesmentMark: String,
			ThirdAssesmentMark: String,
			Exam: String,
			disciplin: String,
			InstitutionName: String
		}
	]
}