Create a New Student

This method creates a new student account in SuccessMaker. If successful, this method will return the newly-created student's GUID in the response body. The HTTP response will also contain a Location header with the new resource's Uniform Resource Identifier (URI).

URI

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

URI Parameters

{school-id} The organization district number

HTTP Method

POST

Resource Formats

text/xml

Authentication

required

Request 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>

Responses

201 Created Student account was created. The location header contains its URI.

400 Bad Request The provided data is incomplete or invalid.

Response Entities

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

This will be the GUID of the newly-created student.