This interchange defines students and contains all their identifying information.
This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.
Prerequisites
- None
Scenarios
- Create a 7-year-old Student, which will be later enrolled at Grand Bend Elementary School.
- Create a 15-year-old Student, which will be later enrolled at Grand Bend High School.
- Update the Phone number on the first Student.
- Update the Address on the second Student.
Resource | PropertyName | IsCollection | DATA_TYPE | REQUIRED/ OPTIONAL | Scenario 1 POST | Scenario 2 POST | Scenario 3 PUT | Scenario 4 PUT | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Students | studentUniqueId | FALSE | string | REQUIRED | 111111 | 222222 | 111111 | 222222 | ||||||||||||||||||
Students | birthDate | FALSE | dateTime | REQUIRED | 1/1/2009 | 1/1/2001 | 1/1/2009 | 1/1/2001 | ||||||||||||||||||
Students | firstName | FALSE | string | REQUIRED | Austin | Madison | Austin | Madison | ||||||||||||||||||
Students | middleName | FALSE | string | REQUIRED | Samuel | Mary | Samuel | Mary | ||||||||||||||||||
Students | lastSurname | FALSE | string | REQUIRED | Jones | Johnson | Jones | Johnson | ||||||||||||||||||
Students | hispanicLatinoEthnicity | FALSE | boolean | REQUIRED | false | false | false | false | ||||||||||||||||||
Students | sexDescriptorexDescriptor | FALSE | integer | REQUIRED | Male | Female | Male | Female | ||||||||||||||||||
Students | birthCity | FALSE | string | REQUIRED | Grand Bend | Grand Bend | Grand Bend | Grand Bend | ||||||||||||||||||
Students | birthCountryDescriptor | FALSE | string | REQUIRED | AG | US | AG | US | ||||||||||||||||||
Students | birthInternationalProvince | FALSE | string | OPTIONAL | ||||||||||||||||||||||
Students | birthStateAbbreviationDescriptorbirthStateAbbreviationDescriptor | FALSE | integer | REQUIRED | TX | TX | TX | TX | ||||||||||||||||||
Students | citizenshipStatusDescriptorcitizenshipStatusDescriptor | FALSE | integer | OPTIONAL | ||||||||||||||||||||||
Students | dateEnteredUS | FALSE | dateTime | OPTIONAL | OPTIONAL | |||||||||||||||||||||
Students | generationCodeSuffix | FALSE | string | REQUIRED | JR | JR | ||||||||||||||||||||
Students | loginId | FALSE | string | OPTIONAL | ||||||||||||||||||||||
Students | maidenName | FALSE | string | OPTIONAL | ||||||||||||||||||||||
Students | multipleBirthStatus | FALSE | boolean | OPTIONAL | ||||||||||||||||||||||
Students | oldEthnicityDescriptoroldEthnicityDescriptor | FALSE | integer | OPTIONAL | ||||||||||||||||||||||
Students | personalTitlePrefix | FALSE | string | REQUIREDOPTIONAL | Mr | Mr | ||||||||||||||||||||
Students | profileThumbnail | FALSE | string | OPTIONAL | ||||||||||||||||||||||
Students | addresses | TRUE | studentAddress[] | OPTIONAL | ||||||||||||||||||||||
studentAddresses | addressTypeDescriptoraddressTypeDescriptor | FALSE | string | REQUIRED* | Temporary | Home | Temporary | Home | ||||||||||||||||||
studentAddresses | city | FALSE | string | REQUIRED* | Grand Bend | Grand Bend | Grand Bend | Grand Bend | ||||||||||||||||||
studentAddresses | postalCode | FALSE | string | REQUIRED* | 78834 | 78834 | 78834 | 78834 | ||||||||||||||||||
studentAddresses | stateAbbreviationDescriptorstateAbbreviationDescriptor | FALSE | integer | REQUIRED* | TX | TX | TX | TX | ||||||||||||||||||
studentAddresses | streetNumberName | FALSE | string | REQUIRED* | 654 Mission Hills | 123 Cedar | 654 Mission Hills | 123 Cedar Street | ||||||||||||||||||
studentAddresses | apartmentRoomSuiteNumber | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentAddresses | studentAddresses | buildingSiteNumber | FALSE | string | OPTIONAL | |||||||||||||||||||||
studentAddresses | countyFIPSCode | FALSE | string | OPTIONAL | OPTIONAL | |||||||||||||||||||||
studentAddresses | latitude | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentAddresses | longitude | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentAddresses | nameOfCounty | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentAddresses | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||||||||||||||||||||
studentAddresses | periods | TRUE | Periods[] | OPTIONAL | ||||||||||||||||||||||
studentAddressPeriods | beginDate | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentAddressPeriods | endDate | FALSE | string | OPTIONAL | ||||||||||||||||||||||
| ||||||||||||||||||||||||||
FALSE | string | OPTIONAL | ||||||||||||||||||||||||
Students | cohortYears | TRUE | studentCohortYear[] | OPTIONAL | ||||||||||||||||||||||
studentCohortYears | cohortYearTypeDescriptorcohortYearTypeDescriptor | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentCohortYears | schoolYearTypeReference | FALSE | schoolYearTypeReference | OPTIONAL | ||||||||||||||||||||||
schoolYearTypeReference | schoolYear | FALSE | integer | OPTIONAL | ||||||||||||||||||||||
| ||||||||||||||||||||||||||
FALSE | ||||||||||||||||||||||||||
integer | OPTIONAL | |||||||||||||||||||||||||
Students | electronicMails | TRUE | studentElectronicMail[] | REQUIRED | ||||||||||||||||||||||
studentElectronicMails | electronicMailAddress | FALSE | string | REQUIRED* | Austin@edficert.org | Madison@edficert.org | Austin@edficert.org | Madison@edficert.org | ||||||||||||||||||
studentElectronicMails | electronicMailTypeDescriptorelectronicMailTypeDescriptor | FALSE | integer | REQUIRED* | Other | Other | Other | Other | ||||||||||||||||||
studentElectronicMails | primaryEmailAddressIndicator | FALSE | boolean | OPTIONAL | ||||||||||||||||||||||
studentElectronicMails | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||||||||||||||||||||
Students | identificationCodes | TRUE | studentIdentificationCode[] | REQUIRED | ||||||||||||||||||||||
studentIdentificationCodes | assigningOrganizationIdentificationCode | FALSE | string | REQUIRED* | State | State | State | State | ||||||||||||||||||
studentIdentificationCodes | identificationCode | FALSE | string | REQUIRED* | 704 | 705 | 704 | 705 | ||||||||||||||||||
studentIdentificationCodes | studentIdentificationSystemDescriptor | FALSE | string | REQUIRED* | State | State | State | State | ||||||||||||||||||
Students | identificationDocuments | TRUE | studentIdentificationDocument[] | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | identificationDocumentUseDescriptoridentificationDocumentUseDescriptor | FALSE | identificationDocumentUseDescriptor | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | personalInformationVerificationDescriptorpersonalInformationVerificationDescriptor | FALSE | personalInformationVerificationDescriptor | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | documentExpirationDate | FALSE | date | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | documentTitle | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | issuerCountryDescriptor | FALSE | issuerCountryDescriptor | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | issuerDocumentIdentificationCode | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentIdentificationDocuments | issuerName | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentIndicator | ||||||||||||||||||||||||||
| FALSE | string |
| OPTIONAL | ||||||||||||||||||||||
Students | internationalAddresses | TRUE | studentInternationalAddress[] | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | addressLine1 | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | addressTypeDescriptoraddressTypeDescriptor | FALSE | integer | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | countryDescriptor | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | addressLine2 | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | addressLine3 | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | addressLine4 | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | beginDate | FALSE | dateTime | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | endDate | FALSE | dateTime | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | latitude | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentInternationalAddresses | longitude | FALSE | string | OPTIONAL | ||||||||||||||||||||||
Students | languages | TRUE | studentLanguage[] | OPTIONAL | ||||||||||||||||||||||
studentLanguages | uses | TRUE | studentLanguageUse[] | OPTIONAL | ||||||||||||||||||||||
studentLanguages | languageDescriptor | FALSE | string | REQUIRED* | Spanish | Spanish | ||||||||||||||||||||
studentLanguageUses | languageUseDescriptorlanguageUseDescriptor | FALSE | string | REQUIRED* | Home language | Home language | ||||||||||||||||||||
| ||||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| ||||||||||||||||||||||||||
Students | otherNames | TRUE | studentOtherName[] | OPTIONAL | ||||||||||||||||||||||
studentOtherNames | firstName | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentOtherNames | lastSurname | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentOtherNames | otherNameTypeDescriptorotherNameTypeDescriptor | FALSE | integer | OPTIONAL | ||||||||||||||||||||||
studentOtherNames | generationCodeSuffix | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentOtherNames | middleName | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentOtherNames | personalTitlePrefix | FALSE | string | OPTIONAL | ||||||||||||||||||||||
Students | personalIdentificationDocuments | TRUE | personalIdentificationDocumentspersonalIdentificationDocuments[] | OPTIONAL | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | documentTitle | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | personalInformationVerificationDescriptor | FALSE | personalInformationVerificationDescriptor | REQUIRED* | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | documentExpirationDate | FALSE | date | OPTIONAL | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | issuerDocumentIdentificationCode | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | issuerName | FALSE | string | OPTIONAL | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | issuerCountryDescriptor | FALSE | issuerCountryDescriptor | OPTIONAL | ||||||||||||||||||||||
studentPersonalIdentificationDocuments | identificationDocumentUseDescriptor | FALSE | identificationDocumentUseDescriptor | REQUIRED* | ||||||||||||||||||||||
| ||||||||||||||||||||||||||
| ||||||||||||||||||||||||||
Students | races | TRUE | studentRace[] | OPTIONAL | ||||||||||||||||||||||
studentRaces | raceDescriptorraceDescriptor | FALSE | integer | REQUIRED* | Black - African American | White | Black - African American | White | ||||||||||||||||||
Students | telephones | TRUE | studentTelephone[] | OPTIONAL | ||||||||||||||||||||||
studentTelephones | telephoneNumber | FALSE | string | REQUIRED* | 111-222-3333 | 111-222-4444 | ||||||||||||||||||||
studentTelephones | telephoneNumberTypeDescriptor telephoneNumberTypeDescriptor | FALSE | integer | REQUIRED* | Home | Home | ||||||||||||||||||||
studentTelephones | orderOfPriority | FALSE | integer | OPTIONAL | ||||||||||||||||||||||
studentTelephones | textMessageCapabilityIndicator | FALSE | boolean | OPTIONAL | ||||||||||||||||||||||
studentTelephones | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||||||||||||||||||||
Students | visas | TRUE | studentVisa[] | OPTIONAL | ||||||||||||||||||||||
studentVisas | visaDescriptorvisaDescriptor | FALSE | integer | OPTIONAL
| ||||||||||||||||||||||
Students | tribalAffiliations | TRUE | TribalAffiliations[] | OPTIONAL | ||||||||||||||||||||||
studentTribalAffiliations | tribalAffiliationDescriptor | FALSE | String | OPTIONAL |