MinUddannelse Api

<back to all web services

RelationerRequest

Henter relationer

Requires Authentication
Required role:MueApi
The following routes are available for this service:
POST/muelev/elevstamdata/relationer
RelationerRequest Parameters:
NameParameterData TypeRequiredDescription
KommuneKodebodyint?NoHent relationer på elever i kommunen
InstitutionsKodebodystringNoHent relationer på elever på skolen
PersonGuidsbodyList<Guid>NoUnik personidentifikation. Angives, hvis der kun ønskes data for enkelte personer
InkluderCprNumrebodyboolNoPersonnumre medtages
RelationerResponse Parameters:
NameParameterData TypeRequiredDescription
RelationerformList<ElevRelationDto>No
ElevRelationDto Parameters:
NameParameterData TypeRequiredDescription
BarnsPersonGuidformGuidNo
RelationPersonnummerformstringNo
RelationformRelationsTypeNo
FornavnformstringNo
EfternavnformstringNo
AdresseoplysningerformAdresseoplysningerDtoNo
ForaeldermyndighedformboolNo
RelationsType Enum:
Mor
Far
Andet
OTP
AdresseoplysningerDto Parameters:
NameParameterData TypeRequiredDescription
VejnavnformstringNo
HusnummerformstringNo
EtageformstringNo
SidedoerformstringNo
Postnummerformint?No
PostdistriktformstringNo
AdressebeskyttelseformboolNo
BynavnformstringNo
KommunekodeformintNo
KommuneformstringNo
SkoledistriktKodeformstringNo
SkoledistriktformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /muelev/elevstamdata/relationer HTTP/1.1 
Host: api.minuddannelse.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"kommuneKode":0,"institutionsKode":"String","personGuids":["00000000000000000000000000000000"],"inkluderCprNumre":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"relationer":[{"barnsPersonGuid":"00000000000000000000000000000000","relationPersonnummer":"String","relation":"Mor","fornavn":"String","efternavn":"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"},"foraeldermyndighed":false}]}