Get Student List

This method returns a listing of students for a given school from SuccessMaker. If successful, this method will return the student list as XML in the response body.

URI

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

URI Parameters

{school-id} The organization district number

HTTP Method

GET

Resource Formats

text/xml

Authentication

required

Request Entities

n/a

Responses

200 OK The student list is returned as the response entity.

Response Entities

 

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

<students self="/schools/{school-id}/students/">

<student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxx- xxxx-xxxxxxxxxxx1">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1</student>

<student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxx- xxxx-xxxxxxxxxxx2">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2</student>

<student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxx- xxxx-xxxxxxxxxxx3">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx3</student>

</students>