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 | sexDescriptor | 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 | birthStateAbbreviationDescriptor | FALSE | integer | REQUIRED | TX | TX | TX | TX |
| Students | citizenshipStatusDescriptor | FALSE | integer | OPTIONAL | ||||
| Students | dateEnteredUS | FALSE | dateTime | OPTIONAL | ||||
| Students | generationCodeSuffix | FALSE | string | REQUIRED | JR | JR | ||
| Students | loginId | FALSE | string | OPTIONAL | ||||
| Students | maidenName | FALSE | string | OPTIONAL | ||||
| Students | multipleBirthStatus | FALSE | boolean | OPTIONAL | ||||
| Students | oldEthnicityDescriptor | FALSE | integer | OPTIONAL | ||||
| Students | personalTitlePrefix | FALSE | string | REQUIRED | Mr | Mr | ||
| Students | profileThumbnail | FALSE | string | OPTIONAL | ||||
| Students | addresses | TRUE | studentAddress[] | OPTIONAL | ||||
| StudentAddress | addressTypeDescriptor | FALSE | string | REQUIRED* | Temporary | Home | Temporary | Home |
| StudentAddress | city | FALSE | string | REQUIRED* | Grand Bend | Grand Bend | Grand Bend | Grand Bend |
| StudentAddress | postalCode | FALSE | string | REQUIRED* | 78834 | 78834 | 78834 | 78834 |
| StudentAddress | stateAbbreviationDescriptor | FALSE | integer | REQUIRED* | TX | TX | TX | TX |
| StudentAddress | streetNumberName | FALSE | string | REQUIRED* | 654 Mission Hills | 123 Cedar | 654 Mission Hills | 123 Cedar Street |
| StudentAddress | apartmentRoomSuiteNumber | FALSE | string | OPTIONAL | ||||
| StudentAddress | buildingSiteNumber | FALSE | string | OPTIONAL | ||||
| StudentAddress | countyFIPSCode | FALSE | string | OPTIONAL | ||||
| StudentAddress | latitude | FALSE | string | OPTIONAL | ||||
| StudentAddress | longitude | FALSE | string | OPTIONAL | ||||
| StudentAddress | nameOfCounty | FALSE | string | OPTIONAL | ||||
| StudentAddress | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||
| StudentAddress | Periods | TRUE | Periods[] | OPTIONAL | ||||
| Period | BeginDate | FALSE | string | OPTIONAL | ||||
| Period | EndDate | FALSE | string | OPTIONAL | ||||
| ||||||||
| students | cohortYears | TRUE | studentCohortYear[] | OPTIONAL | ||||
| studentCohortYears | cohortYearTypeDescriptor | FALSE | string | OPTIONAL | ||||
| studentCohortYears | schoolYearTypeReference | FALSE | schoolYearTypeReference | OPTIONAL | ||||
| schoolYearTypeReference | schoolYear | 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 | electronicMailTypeDescriptor | 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 | identificationDocumentUseDescriptor | FALSE | identificationDocumentUseDescriptor | OPTIONAL | ||||
| StudentIdentificationDocuments | personalInformationVerificationDescriptor | 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 | ||||||||
| ||||||||
| ||||||||
| students | internationalAddresses | TRUE | studentInternationalAddress[] | OPTIONAL | ||||
| StudentInternationalAddresss | addressLine1 | FALSE | string | OPTIONAL | ||||
| StudentInternationalAddresss | addressTypeDescriptor | FALSE | integer | OPTIONAL | ||||
| StudentInternationalAddresss | countryDescriptor | FALSE | string | OPTIONAL | ||||
| StudentInternationalAddresss | addressLine2 | FALSE | string | OPTIONAL | ||||
| StudentInternationalAddresss | addressLine3 | FALSE | string | OPTIONAL | ||||
| StudentInternationalAddresss | addressLine4 | FALSE | string | OPTIONAL | ||||
| StudentInternationalAddresss | beginDate | FALSE | dateTime | OPTIONAL | ||||
| StudentInternationalAddresss | endDate | FALSE | dateTime | OPTIONAL | ||||
| StudentInternationalAddresss | latitude | FALSE | string | OPTIONAL | ||||
| StudentInternationalAddresss | longitude | FALSE | string | OPTIONAL | ||||
| students | languages | TRUE | studentLanguage[] | OPTIONAL | ||||
| StudentLanguages | uses | TRUE | studentLanguageUse[] | OPTIONAL | ||||
| StudentLanguages | languageDescriptor | FALSE | string | REQUIRED* | Spanish | Spanish | ||
| StudentLanguageUses | languageUseDescriptor | FALSE | string | REQUIRED* | Home language | Home language | ||
| ||||||||
| ||||||||
| ||||||||
| Students | otherNames | TRUE | studentOtherName[] | OPTIONAL | ||||
| StudentOtherNames | firstName | FALSE | string | OPTIONAL | ||||
| StudentOtherNames | lastSurname | FALSE | string | OPTIONAL | ||||
| StudentOtherNames | otherNameTypeDescriptor | FALSE | integer | OPTIONAL | ||||
| StudentOtherNames | generationCodeSuffix | FALSE | string | OPTIONAL | ||||
| StudentOtherNames | middleName | FALSE | string | OPTIONAL | ||||
| StudentOtherNames | personalTitlePrefix | FALSE | string | OPTIONAL | ||||
| Students | personalIdentificationDocuments | TRUE | personalIdentificationDocuments[] | 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 | raceDescriptor | 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 | 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 | visaDescriptor | FALSE | integer | OPTIONAL
| ||||
students | TribalAffiliations[] | TRUE | TribalAffiliations[] | OPTIONAL | ||||
TribalAffiliations | tribalAffiliationDescriptor | FALSE | String | OPTIONAL | ||||