v3 Parent > Parent
This interchange defines parents and captures the familial relationship between the student and the parent as well as indicators for the parent for residence, primary parental contact, and emergency contact.
The Parent resource represents a parent or guardian of a student, such as mother, father or caretaker.
Prerequisites
None
Scenarios
Load parent 1
Load parent 2
Update the email address of the first parent created.
Update the address of the Second Parent created.
Resource | Property Name | Is Collection | Data Type | Required / Optional | Scenario 1 | Scenario 2 | Scenario 3 | Scenario 4 |
|---|---|---|---|---|---|---|---|---|
Parents | parentUniqueId | FALSE | string | REQUIRED | ["333333" if possible | system value] | ["444444" if possible | system value] | ["333333" if possible | system value] | ["444444" if possible | system value] |
Parents | firstName | FALSE | string | REQUIRED | Michael | Alexis | Michael | Alexis |
Parents | lastSurname | FALSE | string | REQUIRED | Jones | Johnson | Jones | Johnson |
Parents | generationCodeSuffix | FALSE | string | OPTIONAL | ||||
Parents | loginId | FALSE | string | OPTIONAL | ||||
Parents | maidenName | FALSE | string | OPTIONAL | ||||
Parents | middleName | FALSE | string | OPTIONAL | ||||
Parents | personalTitlePrefix | FALSE | string | OPTIONAL | ||||
Parents | sexDescriptor | FALSE | string | CONDITIONAL | Male | Female | Male | Female |
Parents | addresses | TRUE | parentAddress[] | REQUIRED | ||||
parentAddresses | addressTypeDescriptor | FALSE | addressTypeDescriptor | REQUIRED | Home | Home | Home | Home |
parentAddresses | city | FALSE | string | REQUIRED | Grand Bend | Grand Bend | Grand Bend | Grand Bend |
parentAddresses | postalCode | FALSE | string | REQUIRED | 78834 | 78834 | 78834 | 78834 |
parentAddresses | stateAbbreviationDescriptor | FALSE | stateAbbreviationDescriptor | REQUIRED | TX | TX | TX | TX |
parentAddresses | streetNumberName | FALSE | string | REQUIRED | 654 Mission Hills | 456 Cedar Street | 654 Mission Hills | 456 Cedar Bend |
parentAddresses | apartmentRoomSuiteNumber | FALSE | string | REQUIRED | 100 | 100 | ||
parentAddresses | buildingSiteNumber | FALSE | string | OPTIONAL | ||||
parentAddresses | countyFIPSCode | FALSE | string | OPTIONAL | ||||
parentAddresses | latitude | FALSE | string | OPTIONAL | ||||
parentAddresses | longitude | FALSE | string | OPTIONAL | ||||
parentAddresses | nameOfCounty | FALSE | string | CONDITIONAL | WILLISTON | WILLISTON | WILLISTON | WILLISTON |
parentAddresses | doNotPublishIndicator | FALSE | boolean | REQUIRED | TRUE | TRUE | ||
parentAddresses | periods[] | TRUE | periods[] | OPTIONAL | ||||
parentAddressPeriods | beginDate | FALSE | string | OPTIONAL | ||||
parentAddressPeriods | endDate | FALSE | string | OPTIONAL | ||||
Parents | electronicMails | TRUE | parentElectronicMail[] | REQUIRED | ||||
parentElectronicMails | electronicMailAddress | FALSE | string | REQUIRED | michaeljones@email.com | alexisjohnson@email.com | mJones@email.com | alexisjohnson@email.com |
parentElectronicMails | electronicMailTypeDescriptor | FALSE | electronicMailTypeDescriptor | CONDITIONAL | Home/Personal | Home/Personal | Home/Personal | Home/Personal |
parentElectronicMails | primaryEmailAddressIndicator | FALSE | boolean | REQUIRED | TRUE | TRUE | ||
parentElectronicMails | doNotPublishIndicator | FALSE | boolean | OPTIONAL | ||||
Parents | internationalAddresses | TRUE | parentInternationalAddress[] | OPTIONAL | ||||
parentInternationalAddresses | addressLine1 | FALSE | string | OPTIONAL | ||||
parentInternationalAddresses | addressTypeDescriptor | FALSE | addressTypeDescriptor | OPTIONAL | ||||
parentInternationalAddresses | countryDescriptor | FALSE | countryDescriptor | OPTIONAL | ||||
parentInternationalAddresses | addressLine2 | FALSE | string | OPTIONAL | ||||
parentInternationalAddresses | addressLine3 | FALSE | string | OPTIONAL | ||||
parentInternationalAddresses | addressLine4 | FALSE | string | OPTIONAL | ||||
parentInternationalAddresses | beginDate | FALSE | date | OPTIONAL | ||||
parentInternationalAddresses | endDate | FALSE | date | OPTIONAL | ||||
parentInternationalAddresses | latitude | FALSE | string | OPTIONAL | ||||
parentInternationalAddresses | longitude | FALSE | string | OPTIONAL | ||||
Parents | otherNames | |||||||