GET api/Student/{CivicNumber}

Gets a student object by civic number. The response gives a student an object with contact information and simplified study information. Return the Student object (Http Status 200). If something is wrong HTTP Status: 404 = Student not find. 400 = Missing or or incorrect parameter. 409 = Some internal execution error. 500 = Some runtime exeption.

Request Information

URI Parameters

Name	Description	Type	Additional information
CivicNumber	Student civic number in the format YYYYMMDDnnnn.	string	Required

Body Parameters

None.

Response Information

Resource Description

Student

Name	Description	Type	Additional information
CivicNumber	Personal identification in the format YYYYMMDD-nnnn (for example 19430808-3635).	string	None.
FirstName	Student first name.	string	None.
LastName	Student last name.	string	None.
Mail	The mail adress. Note! This is the local address of JU (in Ladok the student can state his/her own).	string	None.
Phone	Phone number.	string	None.
PostalAddress	Postal address.	Address	None.
RegisteredAddress	Address from the population register (folkbokföringsregistret in Swedish).	Address	None.
Institution	The institution. For example HLK/HHJ/JTH/JIBS/JUE	string	None.
DoctoralStudent	Value Indicates that the student is a doctoral student (Doktorandanställning).	boolean	None.
DistanceStudent	If the student is a distance student.	boolean	None.
Deceased	Value indicating whether this is dead.	boolean	None.
FeeObliged	Value indicating the student is obliged to pay a fee (Avgiftsskyldig). This is a student who pays to read at JU.	boolean	None.
CreditsThisSmester	The current semester registered credits. How many points the student is registered for for the current semester. Zero (0) points are the same as the student is not a student (ie was a former student but not now).	decimal number	None.
Program	If the student is registered on a program in progress. If so, the information is here. Zero if the student is not registered on a program. Note that the student can still be an active student and only read individual courses. If so, there are points on CreditsThisSmester.	Study	None.
CurrentLadokSemester	Current semester code from Ladok for example VT2019, HT2018. Nothing to do with the student but information to know what we base the semester calculations on.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CivicNumber": "sample string 1",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Mail": "sample string 5",
  "Phone": "sample string 6",
  "PostalAddress": {
    "CareOf": "sample string 1",
    "Street": "sample string 2",
    "ZipCode": "sample string 3",
    "City": "sample string 4",
    "Country": "sample string 5"
  },
  "RegisteredAddress": {
    "CareOf": "sample string 1",
    "Street": "sample string 2",
    "ZipCode": "sample string 3",
    "City": "sample string 4",
    "Country": "sample string 5"
  },
  "Institution": "sample string 7",
  "DoctoralStudent": true,
  "DistanceStudent": true,
  "Deceased": true,
  "FeeObliged": true,
  "CreditsThisSmester": 12.1,
  "Program": {
    "Code": "sample string 1",
    "SessionCode": "sample string 2",
    "NameSwedish": "sample string 3",
    "NameEnglish": "sample string 4",
    "Point": "sample string 5",
    "Semester": "sample string 6",
    "EducationFrom": "sample string 7",
    "EducationTo": "sample string 8"
  },
  "CurrentLadokSemester": "sample string 13"
}

application/xml, text/xml

Sample:

<Student xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JU.API.Students.Models">
  <CivicNumber>sample string 1</CivicNumber>
  <CreditsThisSmester>12.1</CreditsThisSmester>
  <CurrentLadokSemester>sample string 13</CurrentLadokSemester>
  <Deceased>true</Deceased>
  <DistanceStudent>true</DistanceStudent>
  <DoctoralStudent>true</DoctoralStudent>
  <FeeObliged>true</FeeObliged>
  <FirstName>sample string 3</FirstName>
  <Institution>sample string 7</Institution>
  <LastName>sample string 4</LastName>
  <Mail>sample string 5</Mail>
  <Phone>sample string 6</Phone>
  <PostalAddress>
    <CareOf>sample string 1</CareOf>
    <City>sample string 4</City>
    <Country>sample string 5</Country>
    <Street>sample string 2</Street>
    <ZipCode>sample string 3</ZipCode>
  </PostalAddress>
  <Program>
    <Code>sample string 1</Code>
    <EducationFrom>sample string 7</EducationFrom>
    <EducationTo>sample string 8</EducationTo>
    <NameEnglish>sample string 4</NameEnglish>
    <NameSwedish>sample string 3</NameSwedish>
    <Point>sample string 5</Point>
    <Semester>sample string 6</Semester>
    <SessionCode>sample string 2</SessionCode>
  </Program>
  <RegisteredAddress>
    <CareOf>sample string 1</CareOf>
    <City>sample string 4</City>
    <Country>sample string 5</Country>
    <Street>sample string 2</Street>
    <ZipCode>sample string 3</ZipCode>
  </RegisteredAddress>
  <UId>sample string 2</UId>
</Student>