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
Skoleaarbodyint?NoSkoleår der ønskes at hentes data for. Default er indeværende skoleår.
HoldtilmeldingerResponse Parameters:
NameParameterData TypeRequiredDescription
HoldtilmeldingerformList<HoldtilmeldingerDto>No
HoldtilmeldingerDto Parameters:
NameParameterData TypeRequiredDescription
PersonGuidformGuidNoUUID for personen
HoldGuidformGuidNoUUID for holdet
StartdatoformDateTimeNoStartdato for holdtilmeldingen
SlutdatoformDateTimeNoSlutdato for holdtilmeldingen
HoldStartdatoformDateTimeNoStartdato for holdet
HoldSlutdatoformDateTimeNoSlutdato for holdet
FagforkortelseformstringNo
HoldbetegnelseformstringNo
FagTypeformFagTypeNo
InstitutionskodeformstringNo
GroupIdformstringNoGroupId jf STIL/Brugeradministrationen, unik for skolen og skoleaar
SkoleaarIdformintNoSkoleåret for holdtilmeldingen.
FagType Enum:
Non
Ukendt
Obligatorisk
Valgfag

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/holdtilmeldinger HTTP/1.1 
Host: api.minuddannelse.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HoldtilmeldingerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ekstern.Api.Services.MUElev.ElevStamdata.Holdtilmeldinger">
  <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>
  <Skoleaar>0</Skoleaar>
</HoldtilmeldingerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HoldtilmeldingerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MinUddannelse.Elev.Logik.EksternApi.ElevStamdataApi.Holdtilmeldinger">
  <Holdtilmeldinger>
    <HoldtilmeldingerDto>
      <FagType>Non</FagType>
      <Fagforkortelse>String</Fagforkortelse>
      <GroupId>String</GroupId>
      <HoldGuid>00000000-0000-0000-0000-000000000000</HoldGuid>
      <HoldSlutdato>0001-01-01T00:00:00</HoldSlutdato>
      <HoldStartdato>0001-01-01T00:00:00</HoldStartdato>
      <Holdbetegnelse>String</Holdbetegnelse>
      <Institutionskode>String</Institutionskode>
      <PersonGuid>00000000-0000-0000-0000-000000000000</PersonGuid>
      <SkoleaarId>0</SkoleaarId>
      <Slutdato>0001-01-01T00:00:00</Slutdato>
      <Startdato>0001-01-01T00:00:00</Startdato>
    </HoldtilmeldingerDto>
  </Holdtilmeldinger>
</HoldtilmeldingerResponse>