GET api/GetIncomeSurveyStudentList?surveyId={surveyId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| surveyId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of IncomeSurveyStudentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SurveyStudentId | integer |
None. |
|
| SurveyId | integer |
None. |
|
| PersonId | globally unique identifier |
None. |
|
| GradeId | integer |
None. |
|
| SchoolId | globally unique identifier |
None. |
|
| StudentFirstName | string |
None. |
|
| StudentLastName | string |
None. |
|
| StudentMiddleName | string |
None. |
|
| BirthDate | date |
None. |
|
| PendingStudent | boolean |
None. |
|
| SSN | string |
None. |
|
| AddedBy | integer |
None. |
|
| Isactive | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"SurveyStudentId": 1,
"SurveyId": 1,
"PersonId": "75ccfe99-5891-403c-9a55-a7915145821b",
"GradeId": 3,
"SchoolId": "d5b3e36a-874c-4436-94e5-e65882e59037",
"StudentFirstName": "sample string 5",
"StudentLastName": "sample string 6",
"StudentMiddleName": "sample string 7",
"BirthDate": "2025-12-06T03:50:35.7069952+00:00",
"PendingStudent": true,
"SSN": "sample string 10",
"AddedBy": 11,
"Isactive": true
},
{
"SurveyStudentId": 1,
"SurveyId": 1,
"PersonId": "75ccfe99-5891-403c-9a55-a7915145821b",
"GradeId": 3,
"SchoolId": "d5b3e36a-874c-4436-94e5-e65882e59037",
"StudentFirstName": "sample string 5",
"StudentLastName": "sample string 6",
"StudentMiddleName": "sample string 7",
"BirthDate": "2025-12-06T03:50:35.7069952+00:00",
"PendingStudent": true,
"SSN": "sample string 10",
"AddedBy": 11,
"Isactive": true
}
]
application/xml, text/xml
Sample:
<ArrayOfIncomeSurveyStudentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.IncomeSurveys">
<IncomeSurveyStudentModel>
<AddedBy>11</AddedBy>
<BirthDate>2025-12-06T03:50:35.7069952+00:00</BirthDate>
<GradeId>3</GradeId>
<Isactive>true</Isactive>
<PendingStudent>true</PendingStudent>
<PersonId>75ccfe99-5891-403c-9a55-a7915145821b</PersonId>
<SSN>sample string 10</SSN>
<SchoolId>d5b3e36a-874c-4436-94e5-e65882e59037</SchoolId>
<StudentFirstName>sample string 5</StudentFirstName>
<StudentLastName>sample string 6</StudentLastName>
<StudentMiddleName>sample string 7</StudentMiddleName>
<SurveyId>1</SurveyId>
<SurveyStudentId>1</SurveyStudentId>
</IncomeSurveyStudentModel>
<IncomeSurveyStudentModel>
<AddedBy>11</AddedBy>
<BirthDate>2025-12-06T03:50:35.7069952+00:00</BirthDate>
<GradeId>3</GradeId>
<Isactive>true</Isactive>
<PendingStudent>true</PendingStudent>
<PersonId>75ccfe99-5891-403c-9a55-a7915145821b</PersonId>
<SSN>sample string 10</SSN>
<SchoolId>d5b3e36a-874c-4436-94e5-e65882e59037</SchoolId>
<StudentFirstName>sample string 5</StudentFirstName>
<StudentLastName>sample string 6</StudentLastName>
<StudentMiddleName>sample string 7</StudentMiddleName>
<SurveyId>1</SurveyId>
<SurveyStudentId>1</SurveyStudentId>
</IncomeSurveyStudentModel>
</ArrayOfIncomeSurveyStudentModel>