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 | sexType | 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 | birthStateAbbreviationType | FALSE | integer | REQUIRED | TX | TX | TX | TX |
Students | citizenshipStatusType | FALSE | integer | OPTIONAL | ||||
Students | dateEnteredUS | FALSE | dateTime | OPTIONAL | ||||
Students | displacementStatus | FALSE | string | OPTIONAL | ||||
Students | economicDisadvantaged | FALSE | boolean | REQUIRED | FALSE | FALSE | FALSE | FALSE |
Students | generationCodeSuffix | FALSE | string | REQUIRED | JR | JR | ||
Students | limitedEnglishProficiencyDescriptor | FALSE | string | REQUIRED | NotLimited | NotLimited | NotLimited | NotLimited |
Students | loginId | FALSE | string | OPTIONAL | ||||
Students | maidenName | FALSE | string | OPTIONAL | ||||
Students | multipleBirthStatus | FALSE | boolean | OPTIONAL | ||||
Students | oldEthnicityType | FALSE | integer | OPTIONAL | ||||
Students | personalTitlePrefix | FALSE | string | REQUIRED | Mr | Mr | ||
Students | profileThumbnail | FALSE | string | OPTIONAL | ||||
Students | schoolFoodServicesEligibilityDescriptor | FALSE | string | REQUIRED | Reduced price | Reduced price | ||
Students | addresses | TRUE | studentAddress[] | OPTIONAL | ||||
StudentAddresss | addressType | FALSE | string | REQUIRED* | Temporary | Home | Temporary | Home |
StudentAddresss | city | FALSE | string | REQUIRED* | Grand Bend | Grand Bend | Grand Bend | Grand Bend |
StudentAddresss | postalCode | FALSE | string | REQUIRED* | 78834 | 78834 | 78834 | 78834 |
StudentAddresss | stateAbbreviationType | FALSE | integer | REQUIRED* | TX | TX | TX | TX |
StudentAddresss | streetNumberName | FALSE | string | REQUIRED* | 654 Mission Hills | 123 Cedar | 654 Mission Hills | 123 Cedar Street |
StudentAddresss | apartmentRoomSuiteNumber | FALSE | string | OPTIONAL | ||||
StudentAddresss | beginDate | FALSE | dateTime | OPTIONAL | ||||
StudentAddresss | buildingSiteNumber | FALSE | string | OPTIONAL | ||||
StudentAddresss | countyFIPSCode | FALSE | string | OPTIONAL | ||||
StudentAddresss | endDate | FALSE | dateTime | OPTIONAL | ||||
StudentAddresss | latitude | FALSE | string | OPTIONAL | ||||
StudentAddresss | longitude | FALSE | string | OPTIONAL | ||||
StudentAddresss | nameOfCounty | FALSE | string | OPTIONAL | ||||
students | characteristics | TRUE | studentCharacteristic[] | OPTIONAL | ||||
StudentCharacteristics | descriptor | FALSE | string | REQUIRED* | Migrant | Migrant | ||
StudentCharacteristics | beginDate | FALSE | dateTime | OPTIONAL | ||||
StudentCharacteristics | designatedBy | FALSE | string | OPTIONAL | ||||
StudentCharacteristics | endDate | FALSE | date | OPTIONAL | ||||
students | cohortYears | TRUE | studentCohortYear[] | OPTIONAL | ||||
studentCohortYears | cohortYearType | FALSE | string | OPTIONAL | ||||
studentCohortYears | schoolYearTypeReference | FALSE | schoolYearTypeReference | OPTIONAL | ||||
schoolYearTypeReference | schoolYear | FALSE | integer | OPTIONAL | ||||
students | disabilities | TRUE | studentDisability[] | OPTIONAL | ||||
StudentDisabilities | disabilityDescriptor | FALSE | string | OPTIONAL | ||||
studentDisabilities | disabilityDeterminationSourceType | FALSE | string | OPTIONAL | ||||
StudentDisabilities | disabilityDiagnosis | FALSE | string | OPTIONAL | ||||
StudentDisabilities | orderOfDisability | 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 | electronicMailType | FALSE | integer | REQUIRED* | Other | Other | Other | Other |
StudentElectronicMails | primaryEmailAddressIndicator | 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 | identificationDocumentUseType | FALSE | integer | OPTIONAL | ||||
StudentIdentificationDocuments | personalInformationVerificationType | FALSE | integer | OPTIONAL | ||||
StudentIdentificationDocuments | documentExpirationDate | FALSE | dateTime | OPTIONAL | ||||
StudentIdentificationDocuments | documentTitle | FALSE | string | OPTIONAL | ||||
StudentIdentificationDocuments | issuerCountryDescriptor | FALSE | string | OPTIONAL | ||||
StudentIdentificationDocuments | issuerDocumentIdentificationCode | FALSE | string | OPTIONAL | ||||
StudentIdentificationDocuments | issuerName | FALSE | string | OPTIONAL | ||||
students | indicators | TRUE | studentIndicator[] | OPTIONAL | ||||
StudentIndicators | indicator | FALSE | string | REQUIRED* | True | True | ||
StudentIndicators | indicatorName | FALSE | string | REQUIRED* | At Risk | At Risk | ||
StudentIndicators | beginDate | FALSE | dateTime | OPTIONAL | ||||
StudentIndicators | designatedBy | FALSE | string | OPTIONAL | ||||
StudentIndicators | endDate | FALSE | datetime | OPTIONAL | ||||
StudentIndicators | indicatorGroup | FALSE | string | OPTIONAL | ||||
students | internationalAddresses | TRUE | studentInternationalAddress[] | OPTIONAL | ||||
StudentInternationalAddresss | addressLine1 | FALSE | string | OPTIONAL | ||||
StudentInternationalAddresss | addressType | 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 | languageUseType | FALSE | string | REQUIRED* | Home language | Home language | ||
Students | learningStyle | FALSE | studentLearningStyle | OPTIONAL | ||||
StudentLearningStyles | auditoryLearning | FALSE | decimal | OPTIONAL | ||||
StudentLearningStyles | tactileLearning | FALSE | decimal | OPTIONAL | ||||
StudentLearningStyles | visualLearning | FALSE | decimal | OPTIONAL | ||||
Students | otherNames | TRUE | studentOtherName[] | OPTIONAL | ||||
StudentOtherNames | firstName | FALSE | string | OPTIONAL | ||||
StudentOtherNames | lastSurname | FALSE | string | OPTIONAL | ||||
StudentOtherNames | otherNameType | FALSE | integer | OPTIONAL | ||||
StudentOtherNames | generationCodeSuffix | FALSE | string | OPTIONAL | ||||
StudentOtherNames | middleName | FALSE | string | OPTIONAL | ||||
StudentOtherNames | personalTitlePrefix | FALSE | string | OPTIONAL | ||||
Students | programParticipations | TRUE | studentProgramParticipation[] | OPTIONAL | ||||
StudentProgramParticipations | programType | FALSE | integer | OPTIONAL | ||||
StudentProgramParticipations | beginDate | FALSE | datetime | OPTIONAL | ||||
StudentProgramParticipations | designatedBy | FALSE | string | OPTIONAL | ||||
StudentProgramParticipations | endDate | FALSE | datetime | OPTIONAL | ||||
studentProgramParticipations | programCharacteristics | TRUE | studentProgramParticipationProgramCharacteristic[] | OPTIONAL | ||||
studentProgramParticipationProgramCharacteristic | programCharacteristicDescriptor | FALSE | string | OPTIONAL | ||||
Students | races | TRUE | studentRace[] | OPTIONAL | ||||
StudentRaces | raceType | 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 | telephoneNumberType | FALSE | integer | REQUIRED* | Home | Home | ||
StudentTelephones | orderOfPriority | FALSE | integer | OPTIONAL | ||||
StudentTelephones | textMessageCapabilityIndicator | FALSE | boolean | OPTIONAL | ||||
students | visas | TRUE | studentVisa[] | OPTIONAL | ||||
StudentVisas | visaType | FALSE | integer | OPTIONAL
|