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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ElevoplysningerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ekstern.Api.Services.MUElev.ElevStamdata.Elevoplysninger">
  <InkluderCprNumre>false</InkluderCprNumre>
  <InstitutionsKode>String</InstitutionsKode>
  <KommuneKode>0</KommuneKode>
  <PersonGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </PersonGuids>
</ElevoplysningerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ElevoplysningerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MinUddannelse.Elev.Logik.Stamdata.ElevStamdataApi.Elevoplysninger">
  <Elev>
    <ElevoplysningerDto>
      <Adresseoplysninger>
        <Adressebeskyttelse>false</Adressebeskyttelse>
        <Bynavn>String</Bynavn>
        <Etage>String</Etage>
        <Husnummer>String</Husnummer>
        <Kommune>String</Kommune>
        <Kommunekode>0</Kommunekode>
        <Postdistrikt>String</Postdistrikt>
        <Postnummer>0</Postnummer>
        <Sidedoer>String</Sidedoer>
        <Skoledistrikt>String</Skoledistrikt>
        <SkoledistriktKode>String</SkoledistriktKode>
        <Vejnavn>String</Vejnavn>
      </Adresseoplysninger>
      <CoNavn>String</CoNavn>
      <Efternavn>String</Efternavn>
      <Elevart>String</Elevart>
      <Elevniveau>String</Elevniveau>
      <Emailadresse>String</Emailadresse>
      <Foedselsdato>0001-01-01T00:00:00</Foedselsdato>
      <Fornavn>String</Fornavn>
      <Hjemmetelefonnummer>String</Hjemmetelefonnummer>
      <HjemmetelefonnummerHemmeligt>false</HjemmetelefonnummerHemmeligt>
      <InstitutionsKommunekode>String</InstitutionsKommunekode>
      <Institutionskode>String</Institutionskode>
      <Kaldeefternavn>String</Kaldeefternavn>
      <Kaldefornavn>String</Kaldefornavn>
      <Koen>String</Koen>
      <Mobiltelefonnummer>String</Mobiltelefonnummer>
      <MobiltelefonnummerHemmeligt>false</MobiltelefonnummerHemmeligt>
      <Modersmaal>String</Modersmaal>
      <OphoertSkolegang>0001-01-01T00:00:00</OphoertSkolegang>
      <PersonGuid>00000000-0000-0000-0000-000000000000</PersonGuid>
      <Personnummer>String</Personnummer>
      <Personstatus>IkkeIndskrevet</Personstatus>
      <Statsborgerskab>String</Statsborgerskab>
    </ElevoplysningerDto>
  </Elev>
</ElevoplysningerResponse>