MinUddannelse Api

<back to all web services

HoldtilmeldingerRequest

Henter holdtilmeldinger

Requires Authentication
Required role:MueApi
The following routes are available for this service:
POST/muelev/elevstamdata/holdtilmeldinger
HoldtilmeldingerRequest Parameters:
NameParameterData TypeRequiredDescription
KommuneKodebodyint?NoHent holdtilmeldinger på elever i kommunen
InstitutionsKodebodystringNoHent holdtilmeldinger på elever på skolen
PersonGuidsbodyList<Guid>NoUnik personidentifikation. Angives, hvis der kun ønskes data for enkelte personer
InkluderCprNumrebodyboolNoPersonnumre medtages
HoldtilmeldingerResponse Parameters:
NameParameterData TypeRequiredDescription
HoldtilmeldingerformList<HoldtilmeldingerDto>No
HoldtilmeldingerDto Parameters:
NameParameterData TypeRequiredDescription
PersonGuidformGuidNo
StartdatoformDateTimeNo
SlutdatoformDateTime?No
FagforkortelseformstringNo
HoldbetegnelseformstringNo
FagTypeformFagTypeNo
InstitutionskodeformstringNo
FagType Enum:
Non
Ukendt
Obligatorisk
Valgfag

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.

POST /muelev/elevstamdata/holdtilmeldinger HTTP/1.1 
Host: api.minuddannelse.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	kommuneKode: 0,
	institutionsKode: String,
	personGuids: 
	[
		00000000000000000000000000000000
	],
	inkluderCprNumre: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	holdtilmeldinger: 
	[
		{
			personGuid: 00000000000000000000000000000000,
			startdato: 0001-01-01,
			slutdato: 0001-01-01,
			fagforkortelse: String,
			holdbetegnelse: String,
			fagType: Non,
			institutionskode: String
		}
	]
}