GET api/v{version}/Student/{districtid}/GetStudents

Request Information

URI Parameters

NameDescriptionTypeAdditional information
districtid

integer

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of StudentsModel
NameDescriptionTypeAdditional information
StudentId

integer

None.

StudentNumber

string

None.

FirstName

string

None.

LastName

string

None.

AddedDt

date

None.

IdConfirmed

string

None.

StudentImage

string

None.

SiteName

string

None.

SiteId

string

None.

Balance

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "StudentId": 1,
    "StudentNumber": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "AddedDt": "2024-05-20T03:50:04.8895694-04:00",
    "IdConfirmed": "sample string 6",
    "StudentImage": "sample string 7",
    "SiteName": "sample string 8",
    "SiteId": "sample string 9",
    "Balance": 10.0
  },
  {
    "StudentId": 1,
    "StudentNumber": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "AddedDt": "2024-05-20T03:50:04.8895694-04:00",
    "IdConfirmed": "sample string 6",
    "StudentImage": "sample string 7",
    "SiteName": "sample string 8",
    "SiteId": "sample string 9",
    "Balance": 10.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfStudentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models">
  <StudentsModel>
    <AddedDt>2024-05-20T03:50:04.8895694-04:00</AddedDt>
    <Balance>10</Balance>
    <FirstName>sample string 3</FirstName>
    <IdConfirmed>sample string 6</IdConfirmed>
    <LastName>sample string 4</LastName>
    <SiteId>sample string 9</SiteId>
    <SiteName>sample string 8</SiteName>
    <StudentId>1</StudentId>
    <StudentImage>sample string 7</StudentImage>
    <StudentNumber>sample string 2</StudentNumber>
  </StudentsModel>
  <StudentsModel>
    <AddedDt>2024-05-20T03:50:04.8895694-04:00</AddedDt>
    <Balance>10</Balance>
    <FirstName>sample string 3</FirstName>
    <IdConfirmed>sample string 6</IdConfirmed>
    <LastName>sample string 4</LastName>
    <SiteId>sample string 9</SiteId>
    <SiteName>sample string 8</SiteName>
    <StudentId>1</StudentId>
    <StudentImage>sample string 7</StudentImage>
    <StudentNumber>sample string 2</StudentNumber>
  </StudentsModel>
</ArrayOfStudentsModel>