MinUddannelse Api

<back to all web services

ElevoplysningerRequest

Henter elevoplysninger

Requires Authentication
Required role:MueApi
The following routes are available for this service:
POST/muelev/elevstamdata/elevoplysninger
ElevoplysningerRequest Parameters:
NameParameterData TypeRequiredDescription
KommuneKodebodyint?NoHent elevoplysninger på elever i kommunen
InstitutionsKodebodystringNoHent elevoplysninger på elever på skolen
PersonGuidsbodyList<Guid>NoUnik personidentifikation. Angives, hvis der kun ønskes data for enkelte personer
InkluderCprNumrebodyboolNoPersonnumre medtages
ElevoplysningerResponse Parameters:
NameParameterData TypeRequiredDescription
ElevformList<ElevoplysningerDto>No
ElevoplysningerDto Parameters:
NameParameterData TypeRequiredDescription
PersonGuidformGuidNo
PersonnummerformstringNo
InstitutionsKommunekodeformstringNo
InstitutionsKommuneformstringNo
InstitutionskodeformstringNo
InstitutionsNavnformstringNo
FornavnformstringNo
EfternavnformstringNo
KaldefornavnformstringNo
KaldeefternavnformstringNo
FoedselsdatoformDateTime?No
KoenformstringNo
StatsborgerskabformstringNo
ModersmaalformstringNo
AdresseoplysningerformAdresseoplysningerDtoNo
CoNavnformstringNo
HjemmetelefonnummerformstringNo
HjemmetelefonnummerHemmeligtformbool?No
MobiltelefonnummerformstringNo
MobiltelefonnummerHemmeligtformbool?No
EmailadresseformstringNo
PersonstatusformPersonStatusNo
OphoertSkolegangformDateTime?No
ElevartformstringNo
ElevniveauformstringNo
OprindelseslandformstringNo
AdresseoplysningerDto Parameters:
NameParameterData TypeRequiredDescription
VejnavnformstringNo
HusnummerformstringNo
EtageformstringNo
SidedoerformstringNo
Postnummerformint?No
PostdistriktformstringNo
AdressebeskyttelseformboolNo
BynavnformstringNo
KommunekodeformintNo
KommuneformstringNo
SkoledistriktKodeformstringNo
SkoledistriktformstringNo
PersonStatus Enum:
IkkeIndskrevet
Indskrevet
Udmeldt

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

{
	elev: 
	[
		{
			personGuid: 00000000000000000000000000000000,
			personnummer: String,
			institutionsKommunekode: String,
			institutionsKommune: String,
			institutionskode: String,
			institutionsNavn: String,
			fornavn: String,
			efternavn: String,
			kaldefornavn: String,
			kaldeefternavn: String,
			foedselsdato: 0001-01-01,
			koen: String,
			statsborgerskab: String,
			modersmaal: String,
			adresseoplysninger: 
			{
				vejnavn: String,
				husnummer: String,
				etage: String,
				sidedoer: String,
				postnummer: 0,
				postdistrikt: String,
				adressebeskyttelse: False,
				bynavn: String,
				kommunekode: 0,
				kommune: String,
				skoledistriktKode: String,
				skoledistrikt: String
			},
			coNavn: String,
			hjemmetelefonnummer: String,
			hjemmetelefonnummerHemmeligt: False,
			mobiltelefonnummer: String,
			mobiltelefonnummerHemmeligt: False,
			emailadresse: String,
			personstatus: IkkeIndskrevet,
			ophoertSkolegang: 0001-01-01,
			elevart: String,
			elevniveau: String,
			oprindelsesland: String
		}
	]
}