GET api/Students/{SchoolYear}/{StudentId}

Returns a Student.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SchoolYear

Numeric Value of the School Year (i.e. 2018 for the 2017-2018 School Year)

integer

Required

StudentId

Application identifier for the Student

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Student object for the specified SchoolYear and StudentId

Student
NameDescriptionTypeAdditional information
StudentUid

The user identifier for the Student.

string

None.

StatePrId

The StatePrId for the Student.

string

None.

StudentPerson

The Person for the Student.

Person

None.

BirthDateVerificationCodeUid

The Birth Date Verification Code user identifier for the Student.

string

None.

BirthDateVerificationCodeDescription

The Birth Date Verification Code description for the Student.

string

None.

BirthPlace

The birth place for the Student.

string

None.

BirthState

The birth state for the Student.

string

None.

BirthCountry

The birth country for the Student.

string

None.

SiteUid

The Site user identifier for the Student's current or last Enrollment in the School Year.

string

None.

GradeUid

The Grade user identifier for the Student's current or last Enrollment in the School Year.

string

None.

HomeRoom

The home room for the Student.

string

None.

EnrollmentStatus

The enrollment status for the Student's current or last Enrollment in the School Year. Values: On_Roll, Off_Roll, Suspended

string

None.

IsEnrolled

The indicator for whether the Student's current or last Enrollment is for the Site.

boolean

None.

Locker

The locker for the Student.

string

None.

LockerCombination

The combination of the locker for the Student.

string

None.

ParkingSpace

The parking space for the Student.

string

None.

DefaultAddress

The default address for the Student.

Address

None.

AddressList

The addresses for the Student. This list includes the default address for the Student.

Collection of Address

None.

DefaultPhone

The default phone for the Student.

Phone

None.

PhoneList

The phones for the Student. This list includes the default phone for the Student.

Collection of Phone

None.

DefaultEmail

The default email for the Student.

Email

None.

EmailList

The emails for the Student. This list includes the default email for the Student.

Collection of Email

None.

SIFRefId

The SIFRefId for the Student.

globally unique identifier

None.

Id

The application identifier for the object. This cannot be changed by the user.

globally unique identifier

None.

DataVersion

The version of the API data

string

None.

ApiName

The name of the object without the Api suffix

string

None.

Response Formats

application/json, text/json

Sample:
{
  "StudentUid": "sample string 1",
  "StatePrId": "sample string 2",
  "StudentPerson": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "AlternateFirstName": "sample string 6",
    "AlternateLastName": "sample string 7",
    "SSN": "sample string 8",
    "Gender": "sample string 9",
    "BirthDate": "2025-04-25T23:53:21.0907055-05:00",
    "HispanicLatino": true,
    "AmericanIndian": true,
    "White": true,
    "Asian": true,
    "PacificIslander": true,
    "Black": true,
    "UnknownRace": true,
    "EmployerName": "sample string 18",
    "LanguageCodeUid": "sample string 19",
    "LanguageCodeDescription": "sample string 20",
    "Id": "34d5df9d-b225-496d-9997-bbea8495e9cb",
    "DataVersion": "sample string 22",
    "ApiName": ""
  },
  "BirthDateVerificationCodeUid": "sample string 3",
  "BirthDateVerificationCodeDescription": "sample string 4",
  "BirthPlace": "sample string 5",
  "BirthState": "sample string 6",
  "BirthCountry": "sample string 7",
  "SiteUid": "sample string 8",
  "GradeUid": "sample string 9",
  "HomeRoom": "sample string 10",
  "EnrollmentStatus": "sample string 11",
  "IsEnrolled": true,
  "Locker": "sample string 13",
  "LockerCombination": "sample string 14",
  "ParkingSpace": "sample string 15",
  "DefaultAddress": {
    "AddressType": "sample string 1",
    "AddressTypeDescription": "sample string 2",
    "Line1": "sample string 3",
    "Line2": "sample string 4",
    "Line3": "sample string 5",
    "Apartment": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "Country": "sample string 9",
    "PostalCode": "sample string 10",
    "Zip": "sample string 11",
    "ZipPlusFour": "sample string 12",
    "RoomNumber": "sample string 13",
    "Id": "b52eb41e-b32d-40f5-98b1-0b98a3d948c0",
    "DataVersion": "sample string 15",
    "ApiName": ""
  },
  "AddressList": [
    {
      "AddressType": "sample string 1",
      "AddressTypeDescription": "sample string 2",
      "Line1": "sample string 3",
      "Line2": "sample string 4",
      "Line3": "sample string 5",
      "Apartment": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Country": "sample string 9",
      "PostalCode": "sample string 10",
      "Zip": "sample string 11",
      "ZipPlusFour": "sample string 12",
      "RoomNumber": "sample string 13",
      "Id": "b52eb41e-b32d-40f5-98b1-0b98a3d948c0",
      "DataVersion": "sample string 15",
      "ApiName": ""
    },
    {
      "AddressType": "sample string 1",
      "AddressTypeDescription": "sample string 2",
      "Line1": "sample string 3",
      "Line2": "sample string 4",
      "Line3": "sample string 5",
      "Apartment": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Country": "sample string 9",
      "PostalCode": "sample string 10",
      "Zip": "sample string 11",
      "ZipPlusFour": "sample string 12",
      "RoomNumber": "sample string 13",
      "Id": "b52eb41e-b32d-40f5-98b1-0b98a3d948c0",
      "DataVersion": "sample string 15",
      "ApiName": ""
    }
  ],
  "DefaultPhone": {
    "MessageDeviceType": "sample string 1",
    "MessageDeviceTypeDescription": "sample string 2",
    "Number": "sample string 3",
    "Description": "sample string 4",
    "Id": "826a5119-3cfb-40fa-a3b4-6b5c572af861",
    "DataVersion": "sample string 6",
    "ApiName": ""
  },
  "PhoneList": [
    {
      "MessageDeviceType": "sample string 1",
      "MessageDeviceTypeDescription": "sample string 2",
      "Number": "sample string 3",
      "Description": "sample string 4",
      "Id": "826a5119-3cfb-40fa-a3b4-6b5c572af861",
      "DataVersion": "sample string 6",
      "ApiName": ""
    },
    {
      "MessageDeviceType": "sample string 1",
      "MessageDeviceTypeDescription": "sample string 2",
      "Number": "sample string 3",
      "Description": "sample string 4",
      "Id": "826a5119-3cfb-40fa-a3b4-6b5c572af861",
      "DataVersion": "sample string 6",
      "ApiName": ""
    }
  ],
  "DefaultEmail": {
    "Address": "sample string 1",
    "Description": "sample string 2",
    "Id": "e01074bb-be36-4e7f-b212-d62d57f2e340",
    "DataVersion": "sample string 4",
    "ApiName": ""
  },
  "EmailList": [
    {
      "Address": "sample string 1",
      "Description": "sample string 2",
      "Id": "e01074bb-be36-4e7f-b212-d62d57f2e340",
      "DataVersion": "sample string 4",
      "ApiName": ""
    },
    {
      "Address": "sample string 1",
      "Description": "sample string 2",
      "Id": "e01074bb-be36-4e7f-b212-d62d57f2e340",
      "DataVersion": "sample string 4",
      "ApiName": ""
    }
  ],
  "SIFRefId": "97a21081-4adb-48f4-8e08-b487a5b4805d",
  "Id": "e0e515b4-8466-46f9-acb7-2b4482d0d9dd",
  "DataVersion": "sample string 18",
  "ApiName": ""
}

application/xml, text/xml

Sample:
<Student xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1">
  <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 18</DataVersion>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">e0e515b4-8466-46f9-acb7-2b4482d0d9dd</Id>
  <AddressList>
    <Address>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">b52eb41e-b32d-40f5-98b1-0b98a3d948c0</Id>
      <AddressType>sample string 1</AddressType>
      <AddressTypeDescription>sample string 2</AddressTypeDescription>
      <Apartment>sample string 6</Apartment>
      <City>sample string 7</City>
      <Country>sample string 9</Country>
      <Line1>sample string 3</Line1>
      <Line2>sample string 4</Line2>
      <Line3>sample string 5</Line3>
      <PostalCode>sample string 10</PostalCode>
      <RoomNumber>sample string 13</RoomNumber>
      <State>sample string 8</State>
      <Zip>sample string 11</Zip>
      <ZipPlusFour>sample string 12</ZipPlusFour>
    </Address>
    <Address>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">b52eb41e-b32d-40f5-98b1-0b98a3d948c0</Id>
      <AddressType>sample string 1</AddressType>
      <AddressTypeDescription>sample string 2</AddressTypeDescription>
      <Apartment>sample string 6</Apartment>
      <City>sample string 7</City>
      <Country>sample string 9</Country>
      <Line1>sample string 3</Line1>
      <Line2>sample string 4</Line2>
      <Line3>sample string 5</Line3>
      <PostalCode>sample string 10</PostalCode>
      <RoomNumber>sample string 13</RoomNumber>
      <State>sample string 8</State>
      <Zip>sample string 11</Zip>
      <ZipPlusFour>sample string 12</ZipPlusFour>
    </Address>
  </AddressList>
  <BirthCountry>sample string 7</BirthCountry>
  <BirthDateVerificationCodeDescription>sample string 4</BirthDateVerificationCodeDescription>
  <BirthDateVerificationCodeUid>sample string 3</BirthDateVerificationCodeUid>
  <BirthPlace>sample string 5</BirthPlace>
  <BirthState>sample string 6</BirthState>
  <DefaultAddress>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">b52eb41e-b32d-40f5-98b1-0b98a3d948c0</Id>
    <AddressType>sample string 1</AddressType>
    <AddressTypeDescription>sample string 2</AddressTypeDescription>
    <Apartment>sample string 6</Apartment>
    <City>sample string 7</City>
    <Country>sample string 9</Country>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <Line3>sample string 5</Line3>
    <PostalCode>sample string 10</PostalCode>
    <RoomNumber>sample string 13</RoomNumber>
    <State>sample string 8</State>
    <Zip>sample string 11</Zip>
    <ZipPlusFour>sample string 12</ZipPlusFour>
  </DefaultAddress>
  <DefaultEmail>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">e01074bb-be36-4e7f-b212-d62d57f2e340</Id>
    <Address>sample string 1</Address>
    <Description>sample string 2</Description>
  </DefaultEmail>
  <DefaultPhone>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">826a5119-3cfb-40fa-a3b4-6b5c572af861</Id>
    <Description>sample string 4</Description>
    <MessageDeviceType>sample string 1</MessageDeviceType>
    <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
    <Number>sample string 3</Number>
  </DefaultPhone>
  <EmailList>
    <Email>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">e01074bb-be36-4e7f-b212-d62d57f2e340</Id>
      <Address>sample string 1</Address>
      <Description>sample string 2</Description>
    </Email>
    <Email>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">e01074bb-be36-4e7f-b212-d62d57f2e340</Id>
      <Address>sample string 1</Address>
      <Description>sample string 2</Description>
    </Email>
  </EmailList>
  <EnrollmentStatus>sample string 11</EnrollmentStatus>
  <GradeUid>sample string 9</GradeUid>
  <HomeRoom>sample string 10</HomeRoom>
  <IsEnrolled>true</IsEnrolled>
  <Locker>sample string 13</Locker>
  <LockerCombination>sample string 14</LockerCombination>
  <ParkingSpace>sample string 15</ParkingSpace>
  <PhoneList>
    <Phone>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">826a5119-3cfb-40fa-a3b4-6b5c572af861</Id>
      <Description>sample string 4</Description>
      <MessageDeviceType>sample string 1</MessageDeviceType>
      <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
      <Number>sample string 3</Number>
    </Phone>
    <Phone>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">826a5119-3cfb-40fa-a3b4-6b5c572af861</Id>
      <Description>sample string 4</Description>
      <MessageDeviceType>sample string 1</MessageDeviceType>
      <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
      <Number>sample string 3</Number>
    </Phone>
  </PhoneList>
  <SIFRefId>97a21081-4adb-48f4-8e08-b487a5b4805d</SIFRefId>
  <SiteUid>sample string 8</SiteUid>
  <StatePrId>sample string 2</StatePrId>
  <StudentPerson>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 22</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">34d5df9d-b225-496d-9997-bbea8495e9cb</Id>
    <AlternateFirstName>sample string 6</AlternateFirstName>
    <AlternateLastName>sample string 7</AlternateLastName>
    <AmericanIndian>true</AmericanIndian>
    <Asian>true</Asian>
    <BirthDate>2025-04-25T23:53:21.0907055-05:00</BirthDate>
    <Black>true</Black>
    <EmployerName>sample string 18</EmployerName>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 9</Gender>
    <HispanicLatino>true</HispanicLatino>
    <LanguageCodeDescription>sample string 20</LanguageCodeDescription>
    <LanguageCodeUid>sample string 19</LanguageCodeUid>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <PacificIslander>true</PacificIslander>
    <SSN>sample string 8</SSN>
    <Suffix>sample string 5</Suffix>
    <Title>sample string 1</Title>
    <UnknownRace>true</UnknownRace>
    <White>true</White>
  </StudentPerson>
  <StudentUid>sample string 1</StudentUid>
</Student>