ResourcesRest CallInputResponse CodeAdditional Instructions
1StudentsGetAll
200 - OK
2StudentsGetByKey605704200 - OK
3StudentsPOST

{
"studentUniqueId": "600000",
"birthDate": "2005-05-15T00:00:00",
"firstName": "Smith",
"hispanicLatinoEthnicity": true,
"lastSurname": "Michael",
"loginId": "michael",
"middleName": "",
"oldEthnicityType": "American Indian Or Alaskan Native",
"personalTitlePrefix": "Mr",
"sexType": "Male",
"addresses": [
{
"addressType": "Temporary",
"city": "Grand Bend",
"nameOfCounty": "WILLISTON",
"postalCode": "78834",
"stateAbbreviationType": "TX",
"streetNumberName": "654 Mission Hills"
}
],
"characteristics": [
{
"descriptor": "Homeless"
}
],
"cohortYears": [],
"disabilities": [],
"electronicMails": [
{
"electronicMailType": "Other",
"electronicMailAddress": "msmith@example.com"
}
],
"identificationCodes": [
{
"assigningOrganizationIdentificationCode": "Local",
"studentIdentificationSystemDescriptor": "Local",
"identificationCode": "704"
},
{
"assigningOrganizationIdentificationCode": "SSN",
"studentIdentificationSystemDescriptor": "SSN",
"identificationCode": "5678901234"
}
],
"identificationDocuments": [
{
"identificationDocumentUseType": "Personal Information Verification",
"personalInformationVerificationType": "Drivers license"
}
],
"indicators": [],
"internationalAddresses": [],
"languages": [],
"otherNames": [],
"programParticipations": [],
"races": [
{
"raceType": "Native Hawaiian - Pacific Islander"
}
],
"telephones": [
{
"telephoneNumberType": "Other",
"orderOfPriority": 1,
"telephoneNumber": "(950) 293 5517"
}
],
"visas": []
}

201 - CreatedThis example uses student unique id being "600000" which should not exist in the populated sandbox.
4StudentsGetByKey600000403 - Forbidden
5StudentSchoolAssociationPost

{
"studentReference": {
"studentUniqueId": "600000"
},
"schoolReference": {
"schoolId": 255901107
},
"entryDate": "2011-08-23T00:00:00",
"entryGradeLevelDescriptor": "First grade"
}

201 - CreatedThis example uses the previously created student unique id and assigns a school that already exists in the database. So we are not creating a new school here.
6StudentGetByKey600000200 - OKResponse body now should show the student information

Because you tried inserting a record with no student school association, you are unable to retrieve the student.  You need to establish a studentschoolassociation.  


  • No labels