GET api/student/getBasicStudent/{studentProgramId}

Returns basic information about a student. full name, poseidon booking id and student program id. If no student details are found it will return an empty response.

Request Information

URI Parameters

Name	Type	Additional information
StudentProgramId	integer	None.
StudentProgramIds	Collection of integer	None.
Name	string	None.
studentProgramId	string	None.

Body Parameters

None.

Response Information

Resource Description

Basic student information

StudentResponseOfStudentBasicInfo

Name	Type	Additional information
Message	string	None.
HasError	boolean	None.
Data	StudentBasicInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "hasError": true,
  "data": {
    "studentProgramId": 1,
    "studentFullName": "sample string 2",
    "studentPoseidonId": "sample string 3",
    "programStart": "sample string 4",
    "programLength": "sample string 5",
    "studentCountry": "sample string 6",
    "studentDob": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<StudentResponseOfStudentBasicInfoK6lwLlVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Data>
    <ProgramLength>sample string 5</ProgramLength>
    <ProgramStart>sample string 4</ProgramStart>
    <StudentCountry>sample string 6</StudentCountry>
    <StudentDob>sample string 7</StudentDob>
    <StudentFullName>sample string 2</StudentFullName>
    <StudentPoseidonId>sample string 3</StudentPoseidonId>
    <StudentProgramId>1</StudentProgramId>
  </Data>
  <Message>sample string 1</Message>
</StudentResponseOfStudentBasicInfoK6lwLlVo>