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 |
---|
A parent record will report when they are a guardian to a student with an enrollment aligned to a scoped year.
|
When using data in Campus that has an effective date, the following logic will be applied to determine the scope year(s) to report the data to.
|
When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) to report the data to.
|
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 Labels in bold are part of the Natural Key and are required data elements for information to send to Ed-Fi.
Data Element Label | Business Requirement | Business Rules | M, C or O | Location |
---|---|---|---|---|
id | The unique identifier of the resource. | M | ||
parentUniqueId | A unique alpha-numeric code assigned to a parent. | Report the Ed-Fi ID. On resync of the Parents resource, if the Ed-Fi ID is NULL, a value will be generated and stored in the database. Format:
| M | Census> People> Demographics > Ed-Fi ID person.edfiid |
addresses | Report the person's address(s). | This field is optional, does not report. | O | |
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. | This field is optional, does not report. | O | |
firstName | A name given to an individual at birth, baptism, or during anothernaming ceremony, or through legal change. | 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 parent International Addresses. 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. | 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. | Report the middle name from the person's current identity record. | O | Census > People > Identities > Middle Name identity. middleName |
otherNames | An unordered collection of parent Other Names. 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 parent telephones. This entity represents a parent or guardian of a student, such as mother, father or caretaker. | This field is optional, does not report. | O | |
classroom Volunteer Descriptor | Classification of classroom volunteer capacity of a parent. E.g., Full-time volunteer or part-time volunteer. General purpose but initially implemented for Early Education. | If a value exists, and it is mapped in the Resource Preferences area, report the mapped value. Otherwise, do not report. | O | Student Information > State Programs > Early Education > Participant Type EarlyEducation CaregiverMN. participantType |
highestCompleted LevelOf Education Descriptor | The extent of formal instruction a parent has received (e.g., the highest grade in school completed or its equivalent or the highest degree received). This endpoint is actually referencing the levelOfEducation Descriptor, with the specific namespace: 'education.mn.gov/ LevelOfEducationDescriptor' | If a value exists, and it is mapped in the Resource Preferences area, report the mapped value. Otherwise, do not report. | O | Student Information > State Programs > Early Education > Educational Background EarlyEducation CaregiverMN. educational Background |
birthDate | The month, day, and year on which the parent was born. | Report the value if it exists. Otherwise, do not report. | O | Census > People > Identities > Birth Date |
householdIncome | Annual income of the household in monetary units. | Report the value if it exists. Otherwise, do not report. | O | Student Information > State Programs > Early Education > Household Income EarlyEducation CaregiverMN. household Income |
householdSize | Number of people in the household. | Report the value if it exists. Otherwise, do not report. | O | Student Information > State Programs > Early Education > Household Members EarlyEducation CaregiverMN. household Members |
receiving Interpreter Assistance | Is parent is receiving interpreter assistance? | Report 'true' if checkbox is selected. Otherwise, report 'false'. | O | Student Information > State Programs > Early Education > Requires Interpreter EarlyEducation CaregiverMN. require Interpreter |
_etag | A unique system-generated value that identifies the version of the resource. | This field is optional, does not report. | O |
Resource Preferences
The Ed-Fi Configuration tool is used to establish Ed-Fi data resources.
The following describes how to set the resource preferences for the Parents resource.
Select the appropriate Ed-Fi Code for the Classroom Volunteer Descriptors.
EarlyEducationCaregiverMN Participant Type UI Location Student Information > State Programs > Early Education > Participant Type Select the appropriate Ed-Fi Code for the Level of Education Descriptors.
EarlyEducationCaregiverMN Educational Background UI Location Student Information > State Programs > Early Education > Educational Background Click Save.