Tool Search: Ed-Fi
This entity represents a parent or guardian of a student, such as mother, father or caretaker.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When the Guardian check box is checked AND 1 person is a student and 1 person is not a student.
|
| Put | A record will be updated when any of the following are changed and saved:
|
| Delete | N/A - a Parent record is a shared resource among all districts in the state and cannot be deleted. When the Student Parent Association is removed, the district will no longer have authorization to see the parent record. |
School Exclude, Calendar Exclude, Resource Toggle and Resync Logic
This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.
| Action | Trigger |
|---|---|
| None | If a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send. |
| Resync | If a record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be deleted from the Ed-Fi Identity Mapping table. |
| Resync | If a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it will be deleted from the ODS. |
| Resync | If a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes. |
Natural Key Changes, Cascading Updates, and Deletes Logic
This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.
| Action | Trigger |
|---|---|
| Delete/Post | Cascading Deletes: The logic for an Ed-FI ID change will update all resources impacted by this change. |
Scope Year Logic
This table describes scope year logic of this object.
| Business Rules |
|---|
If student has more than one Guardian, report the lowest personID for the guardians in related Pair .
|
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
| campusObjectType | Object Key Data Source |
|---|---|
| Person | personID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
| Campus Table | Ed-Fi Action | Fields |
|---|---|---|
| relatedPair | Post/Put/Delete | The primary table used for sending data for this resource. |
| household | Put | Addresses |
| contact | Put | Email, Telephone |
| identity | put | First name, Last Name, Middle Name Suffix, gender |
Object Data Elements
This table describes data elements sent within the Parents resource.
| Data Element Label | Business Requirement | Business Rules | M, C or O | Data Source GUI Path | Database Field |
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | |||
| parentUniqueId | A unique alpha-numeric code assigned to a parent. |
| M | ||
| addresses | Report the person's address(s). |
| O | Household Addresses > Mailing Household Membership > Start Date Household Addresses > Start Date | HouseholdLocation.mailing |
| electronicMails | The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. |
| O | Census> People> Demographics > Email | contact.email |
| firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. NEDM First Name. | Report the first name from the person's current identity record. | M | Census > People > Identities > First Name | identity.firstName |
| generationCode Suffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). | Report the Suffix from the person's current identity record. | C | Census > People > Identities> Suffix | identity.suffix |
| international Addresses | An unordered collection of parentInternationalAddresses. This entity represents a parent or guardian of a student, such as mother, father or caretaker. | This field is optional, does not report. | O | ||
| languages | The language(s) the individual uses to communicate. | This field is optional, does not report. | |||
| lastSurname | The name borne in common by members of a family. NEDM Last Name/Surname. | Report the last name from the person's current identity record. | M | Census > People > Identities > Last Name | identity.lastName |
| loginId | The login ID for the user; used for security access control interface. | This field is optional, does not report. | O | ||
| maidenName | The person''s maiden name, if applicable. | This field is optional, does not report. | O | ||
| middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony. NEDM Middle Name. | Report the middle name from the person's current identity record. | O | Census > People > Identities > Middle Name | identity.middleName |
| otherNames | An unordered collection of parentOtherNames. This entity represents a parent or guardian of a student, such as mother, father or caretaker. | This field is optional, does not report. | O | ||
| personal identification Documents | An unordered collection of parentIdentificationDocuments. This entity represents a parent or guardian of a student, such as mother, father or caretaker. | This field is optional, does not report. | O | ||
| personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. | This field is optional, does not report. | O | ||
| sexDescriptor | A person's gender. |
| O | Census > People > Identities > Gender | identity.Gender |
| telephones | An unordered collection of parentTelephones. This entity represents a parent or guardian of a student, such as mother, father or caretaker., |
| O | Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager | contact.homephone contact. workphone contact.cellphone contact.pager |
| _etag | A unique system-generated value that identifies the version of the resource. | This field is optional, does not report. | O |
