MinUddannelse Api

RelationerRequest

Henter relationer

**Requires Authentication**
Required role:	MueApi

The following routes are available for this service:
POST	/muelev/elevstamdata/relationer

**RelationerRequest** Parameters:
Name	Parameter	Data Type	Required	Description
KommuneKode	body	int?	No	Hent relationer på elever i kommunen
InstitutionsKode	body	string	No	Hent relationer på elever på skolen
PersonGuids	body	List<Guid>	No	Unik personidentifikation. Angives, hvis der kun ønskes data for enkelte personer
InkluderCprNumre	body	bool	No	Personnumre medtages

**RelationerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Relationer	form	List<ElevRelationDto>	No

**ElevRelationDto** Parameters:
Name	Parameter	Data Type	Required
BarnsPersonGuid	form	Guid	No
RelationPersonnummer	form	string	No
Relation	form	RelationsType	No
Fornavn	form	string	No
Efternavn	form	string	No
Adresseoplysninger	form	AdresseoplysningerDto	No
Foraeldermyndighed	form	bool	No

**RelationsType** Enum:
Mor
Far
Andet
OTP

**AdresseoplysningerDto** Parameters:
Name	Parameter	Data Type	Required
Vejnavn	form	string	No
Husnummer	form	string	No
Etage	form	string	No
Sidedoer	form	string	No
Postnummer	form	int?	No
Postdistrikt	form	string	No
Adressebeskyttelse	form	bool	No
Bynavn	form	string	No
Kommunekode	form	int	No
Kommune	form	string	No
SkoledistriktKode	form	string	No
Skoledistrikt	form	string	No

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

{
	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
		}
	]
}