Get Student Data

This method returns student account data from SuccessMaker. If successful, this method will return the student resource as XML in the response body.

URI

https://[serverurl]/lms/api/schools/{school-id}/students/{guid}

{guid} The student's globally unique identifier

HTTP Method

GET

Resource Formats

text/xml

Authentication

required

Request Entities

n/a

Responses

200 OK The student is returned as the response entity.

404 Not Found There is no student with this GUID.

Response Entities

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Student>

<firstName>Rest</firstName>

<middleName></middleName>

<lastName>Student</lastName>

<username>student11111_RI</username>

<password>student11111_RI</password>

<gender>FEMALE</gender>

<studentDistrictId>student11111_RI</studentDistrictId>

<grade>1</grade>

<specialServices>PLAN_504</specialServices>

<hasEconomicDisadvantage>YES</hasEconomicDisadvantage>

<hasDisability>YES</hasDisability>

<hasEnglishProficiency>YES</hasEnglishProficiency>

<isMigrant>YES</isMigrant>

<ethnicity>AFRICAN_AMERICAN</ethnicity>

</Student>