Go to https://apidocs.ed-fi.org
2. Click on 'Resources'
3. Wait for the page to completely load
4. Click the 'Authorize' button
5. Click the 'Authorize' button on the dialog that is displayed
6. Again, wait for the page to completely reload
7. Scroll down to the localEducationAgencies section and click on it to expand it
8. Click the top ‘Get’ button to expand for more information on that specific operation
9. Click the ‘Try it out!’ button
10. Scroll down to the ‘students’ section and click on it to expand it
11. Click on ‘POST’ to expand
12. Input student record in JSON format to be sent via the POST verb.
{
"studentUniqueId": "",
"birthDate": "2005-12-15T00:00:00",
"firstName": "",
"lastSurname": "",
"hispanicLatinoEthnicity": false,
"sexType": "Female"
}
Copy and paste the above JSON.
- Use your initials and three random numerals for the studentUniqueId
- Use anything for the firstName and lastSurName
13. Click the 'Try it out!' button
Expected result
14. Click the second 'GET' option under 'students' ("Get By Example")
15. Input the studentUniqueId of the student just posted into the studentUniqueId text box in the parameters section displayed
16. Click the 'Try it out!' button
17. Scroll up to the 'schools' section and click on it to expand it
18. Click 'POST' to open that operation
19. Input school JSON into the 'body' text area
- For the schoolId, change the last three characters that are currently --- to three random numbers, or your row and seat number.
- This occurs three times in the JSON
{
"localEducationAgencyReference": {
"localEducationAgencyId": 255901
},
"schoolId": 255901---,
"nameOfInstitution": "New High School",
"operationalStatusType": "Active",
"shortNameOfInstitution": "NHS",
"stateOrganizationId": "255901---",
"webSite": "http://www.GBISD.edu/NHS/",
"administrativeFundingControlDescriptor": "Public School",
"charterStatusType": "Not a Charter School",
"type": "Regular",
"titleIPartASchoolDesignationType": "Not designated as a Title I Part A school",
"addresses": [
{
"addressType": "Mailing",
"city": "Grand Bend",
"nameOfCounty": "Williston",
"postalCode": "73334-2035",
"stateAbbreviationType": "TX",
"streetNumberName": "P.O. Box 123"
},
{
"addressType": "Physical",
"city": "Grand Bend",
"nameOfCounty": "Williston",
"postalCode": "73334",
"stateAbbreviationType": "TX",
"streetNumberName": "123 Maple Street"
}
],
"educationOrganizationCategories": [
{
"type": "School"
}
],
"identificationCodes": [
{
"educationOrganizationIdentificationSystemDescriptor": "SEA",
"identificationCode": "255901---"
}
],
"institutionTelephones": [
{
"institutionTelephoneNumberType": "Main",
"telephoneNumber": "(950) 325-1231"
},
{
"institutionTelephoneNumberType": "Fax",
"telephoneNumber": "(950) 393-1232"
}
],
"schoolCategories": [
{
"type": "High School"
}
],
"gradeLevels": [
{
"gradeLevelDescriptor": "Eleventh grade"
},
{
"gradeLevelDescriptor": "Ninth grade"
},
{
"gradeLevelDescriptor": "Tenth grade"
},
{
"gradeLevelDescriptor": "Twelfth grade"
}
]
}
20. Click the 'Try it out!' button
Expected Result
21. Scroll down to the 'studentSchoolAssociations' section and click on it to expand it
22. Click on the 'POST' to expand the operation section
23. Input the student school associaton JSON into the 'body' text area
Use the JSON below, but update the studentUniqueId and schoolId with the values used in the previous POST operations
{
"studentReference": {
"studentUniqueId": ""
},
"schoolReference": {
"schoolId": 255901---
},
"entryDate": "2010-08-23T00:00:00",
"entryGradeLevelDescriptor": "Ninth grade"
}
24. Click the 'Try it out!' button
Expected Result
25. Return to the second 'GET' option under 'students' ("Get By Example")
26. Input the studentUniqueId of the new student you created earlier into the studentUniqueId text box in the parameters section again
27. Click the 'Try it out!' button
Expected Result
