GET api/Student/Search?CivicNumber={CivicNumber}&FirstName={FirstName}&LastName={LastName}&MaxItemsToReturn={MaxItemsToReturn}&Page={Page}

Searches for students from Ladok, based on the given selection. Returns a small object with the student's name and social civic number. You can omit the parameters that are not used. For example, StudentSearch?CivicNumber=1980* Return StudentSearchResponse object (Http Status 200). If something is wrong HTTP Status: 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	Personal identification in the format YYYYMMDD-nnnn (for example 19430808-3635). You search a subset, use the wildcard character (). For example 19430808, 08-3.	string	Default value is
FirstName	First name, not Case sensitivity. You search a subset, use the wildcard character (). For example Sve, en.	string	Default value is
LastName	Last name, not Case sensitivity. You search a subset, use the wildcard character (). For example Svens, ensso.	string	Default value is
MaxItemsToReturn	Maximum number of entries to return from search. Default is 50, max is 400.	integer	Default value is 50
Page	To use if pagination. Defalut page 1.	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

StudentSearchResponse

Name	Description	Type	Additional information
Students	List of students who match selection.	Collection of StudentSearchData	None.
TotalMatches	The total number of students who matched the selection in Ladok.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Students": [
    {
      "CivicNumber": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3"
    },
    {
      "CivicNumber": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3"
    }
  ],
  "TotalMatches": 1
}

application/xml, text/xml

Sample:

<StudentSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JU.API.Students.Models">
  <Students>
    <StudentSearchData>
      <CivicNumber>sample string 1</CivicNumber>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
    </StudentSearchData>
    <StudentSearchData>
      <CivicNumber>sample string 1</CivicNumber>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
    </StudentSearchData>
  </Students>
  <TotalMatches>1</TotalMatches>
</StudentSearchResponse>