/
Edit a Student

Edit a Student

Owned by Kostadin S

Using the LinkIt! REST API, you can edit the First Name, Middle Name, Last Name, Local Code, State Code, Gender, Race, Date of Birth, Grade, SISID and AdminSchoolID.

Resource URI
/students/{id}
HTTPS PUT
/students/{id}?timestamp={TimeStamp}&accesskey={AccessKey}&tag={Token}
Parameters for Request URL

The following parameters should be included in the request URL of the HTTPS PUT call to edit a student.

Parameter
Required?
Data Type
Description
idYesINTEGER

the unique ID that identifies the student in the LinkIt! database.

TimeStampYesDATETIMEthe GMT time at which the call is generated. EXAMPLE: 5/1/2013+5:10:5+PM
AccessKeyYesSTRING (128)a unique key associated with the API user. EXAMPLE: 123456789-987654321
TagYesSTRING (128)token generated for authorization and authentication.
Parameters for Request Header

The following parameters may be included in the request header of the HTTPS PUT call to edit a student.

ParameterRequiredData TypeDescription
FirstNameNoSTRING (100)

the first name of the student. EXAMPLES: TIM, AMY, JOHN 

MiddleNameNoSTRING (100)

the first name of the student. EXAMPLES: JONES, MILLER, SMITH 

LastNameNoSTRING (100)

the first name of the student. EXAMPLES: JONES, MILLER, SMITH 

LocalCodeNoSTRING (20)

the local code used by the district or the Student Information System to identify each student. EXAMPLES: 10023, 100323243, 00011344

StateCodeNoSTRING (20)the code used by the state to identify each student. May or may not be the same as the local code. EXAMPLE: NY123456, 00112233
GenderNoSTRING (100)the gender of the student, MALE, FEMALE and UNKnOWN.
RaceNoSTRING (50)the race of the student EXAMPLES: ASIAN, HISPANIC
DateOfBirthNoDATETIMEthe date and time when the student was born. EXAMPLE: 9/30/2002 12:00:00 AM
GradeNoSTRING (20)the current grade of the student.EXAMPLE: K, 1, 2, ...12
SISIDNoINTEGERa unique ID that identifies the student in the district's Student Information System. EXAMPLES: 1123
AdminSchoolIDNoINTEGERthe LinkIt! ID of the main school that the student is enrolled in. (Note: A student can still be assigned to multiple classes that take place in different schools.)
StatusNoSTRING (50)the status of the student,  ACTIVE or INACTIVE ("A" or "I" are also acceptable parameters).

When editing a student, only include in the request header the fields that you would like to edit. Any field that is not included in the request header will be left unchanged following the call. If a field is included with an empty string, the field will be set to blank in the database.

Response

The following fields are included in the response following an HTTPS PUT call to edit a student.

Field NameData TypeDescriptionExample
ResultSTRING (10)indicates whether the student is edited successfully.

SUCCESS

ERROR

DataJSON/XML

returns properties of the edited student if result is SUCCESS.

 

 Returned data includes
  • StudentID
  • FirstName
  • MiddleName
  • LastName
  • LocalCode
  • StateCode
  • Gender
  • Race
  • Status
  • DateofBirth
  • Grade
  • SISID
  • AdminSchoolID
  • CreatedDate
  • ModifiedDate

Note

All the fields will be included in the response, regardless of which fields are listed in the request header for editing. Furthermore, following a successful edit, the student will have a new ModifiedDate.

 

Check out the Student page to learn more about the various properties that define a student.

See below for detailed examples.
ErrorSTRING (100)

provides explanation if result is ERROR."Null" is returned if result is SUCCESS.

Click here for a list of error messages.
Examples

Example 1

Change the Middle Name of the student (Student ID: 151557) to "Martines", while keeping all other properties unchanged.
 

 

 JSON
Method

PUT

Request URL
/students/151557?timestamp=5%2f21%2f2013+1%3a54%3a14+PM&accesskey=123456789-987654321&tag=658ffb102ab60e6b585a576d0390010ea3eb6cd9
Request Header
{ "MiddleName": "Martines", }
Response Content
{"Result":"SUCCESS", "Data":{"Student":{"StudentID":151557, "FirstName":"James", "MiddleName":"Martines", "LastName":"White", "LocalCode":"410000120179", "StateCode":"b", "Gender":"Unknown", "Race":"White", "Status":"Active", "DateOfBirth":"", "Grade":"KA", "SISID":"", "AdminSchoolID":"1182", "CreatedDate":"", "ModifiedDate":"5/29/2013 3:56:21 PM"}}, "Error":null}
 XML
Method

PUT

Request URL
/students/151557?timestamp=5%2f29%2f2013+3%3a56%3a07+PM&accesskey=123456789-987654321&tag=5c38b9a5c8c29fb4c4d426637b06c6a61b398128
Request Header
<StudentElement xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><MiddleName>Martines</MiddleName></StudentElement>
Response Content
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Result>SUCCESS</Result><Data><Student><StudentID>151557</StudentID><FirstName>James</FirstName><MiddleName>Martines</MiddleName><LastName>White</LastName><LocalCode>410000120179</LocalCode><StateCode>b</StateCode><Gender>Unknown</Gender><Race>White</Race><Status>Active</Status><DateOfBirth /><Grade>KA</Grade><SISID /><AdminSchoolID>1182</AdminSchoolID><CreatedDate /><ModifiedDate>5/29/2013 4:00:18 PM</ModifiedDate></Student></Data></Response>

Example 2

Change the LocalCode of the student (StudentID: 151557) to "410000120178" and Grade to "K", while keeping all other properties unchanged.
 

 

 JSON
Method

PUT

Request URL
/students/151557?timestamp=5%2f29%2f2013+4%3a16%3a58+PM&accesskey=123456789-987654321&tag=658ffb102ab60e6b585a576d0390010ea3eb6cd9
Request Header
{ "LocalCode": "410000120179", "Grade": "K", }
Response Content
{"Result":"SUCCESS", "Data":{"Student":{"StudentID":151557, "FirstName":"James", "MiddleName":"Martines", "LastName":"White", "LocalCode":"410000120178", "StateCode":"b", "Gender":"Unknown", "Race":"White", "Status":"Active", "DateOfBirth":"", "Grade":"K", "SISID":"", "AdminSchoolID":"1182", "CreatedDate":"", "ModifiedDate":"5/29/2013 6:03:45 PM"}}, "Error":null}
 XML
Method

PUT

Request URL
/students/151557?timestamp=5%2f29%2f2013+6%3a04%3a36+PM&accesskey=123456789-987654321&tag=658ffb102ab60e6b585a576d0390010ea3eb6cd9
Request Header
<StudentElement xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <LocalCode>410000120178</LocalCode> <Grade>K</Grade></StudentElement>
Response Content
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Result>SUCCESS</Result><Data><Student><StudentID>151557</StudentID><FirstName>James</FirstName><MiddleName>Martines</MiddleName><LastName>White</LastName><LocalCode>410000120178</LocalCode><StateCode>b</StateCode><Gender>Unknown</Gender><Race>White</Race><Status>Active</Status><DateOfBirth /><Grade>K</Grade><SISID /><AdminSchoolID>1182</AdminSchoolID><CreatedDate /><ModifiedDate>5/29/2013 6:05:49 PM</ModifiedDate></Student></Data></Response>

Navigation and Reference

Expand all   Collapse all

Related content