Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleClick here to view all the use cases pertaining to the /parent endpoint:

#

Use Case Title

Use Case Description

What to Submit/retrieve

1.0

Sending parent/guardian information for each parent/guardian

The parent/guardian data collection is optional for LEAs to submit to WISEdata.

  • The vendor authorization is based on that LEA ID prefix (e.g. 5006058-JS007), which is the LEA ID in the target year, i.e. 2021-22 SY.

  • The order for posting JSON is: /student, /studentSchoolAssociation, /parent, then /studentParentAssociation

  • The First Name, Last Name, and Parent Unique ID are required data properties. Other data properties are optional.

  • Without posting the /studentParentAssociation record, vendor cannot do a GET on /parent

  • The /Parent record cannot be updated until the /studentParentAssociation record is posted.

POST on /parents:
parentUniqueId : EdFiLEAid+’-’+’parentuniqueidinSISsystem
firstName:
lastSurname:
middleName:
generationCodeSuffix: I through XV, Sr, Jr, and SJ (trailing punctuation must be removed from the from the string)
addresses:
addressTypeDescriptor: Home; and Mailing
city
postalCode
stateAbbreviationDescriptor
streetNumberName
apartmentRoomSuiteNumber
electronicMails:
electronicMailTypeDescriptor: Home/Personal; and Work
electronicMailAddress
languages:
languageDescriptor
telephones
telephoneNumber
telephoneNumberTypeDescriptor: Mobile; Home; Work; and Other

2.0

Submit the student's parent/guardian information for Milwaukee School District

(This only applies to vendors that support Carmen Schools and Milwaukee College Prep 'MCP')

Milwaukee School District uses three different SIS vendors. Therefore, vednors supporting Carmen and MCP schools will need to included something to differentiate the parents from MPS and each other.

SIS vendors can use the individual Schoolid as part of the ParentUniqueId, but they would need to appropriately handle students moving between their schools.

Otherwise, they could pick a single SchoolId, or 'Carmen'/'MCP', or 'PowerSchool'/'Skyward', or anything else that would make sense, such as a tenant number if available in the SIS.

Student's /parent and /StudentParentAssociation endpoints is successfully submitted with the Parent Unique ID may be as follows:

Ed-Fi LEA ID +'-'+'Differentiating Factor'+'-'+ Parent Unique ID in SIS System

Differentiating Factor: Something that uniquely identifies the parent within the SIS and is not also used by another SIS to identify parent in the same district.

3.0

Sending parent/guardian information when they more than one students in the same LEA

  • DPI expects one /parent record when parent/guardian has multiple students attending the same LEA.

  • One /studentParentAssociation record should be submitted for each student

4.0

Sending parent/guardian information when they have multiple addresses

Parents/guardians could have multiple households and multiple address. DPI only requires primary home address and mailing address of parent/guardian if different than the home address.

Every school district has a different process for parent data sharing agreement. However, parents/guardians can choose to opt-in or opt-out of the agreement. By law, parents/guardians always have the right to opt-out at any time of the school year. Until they opt-out default is opt-in for data sharing which includes address as well.

POST on /parents:
addresses:
addressTypeDescriptor : Home
city
postalCode
stateAbbreviationDescriptor
streetNumberName
apartmentRoomSuiteNumber

addressTypeDescriptor : Mailing
city
postalCode
stateAbbreviationDescriptor
streetNumberName
apartmentRoomSuiteNumber

5.0

Sending the address for a parent who opted out of address data sharing

  • If opt-out from data sharing happened before submitting address to WISEdata, then do NOT submit student address to WISEdata.

  • If opt-out from data sharing happens after submitting address to WISEdata, then delete the address of student from API.

DPI may share parents addresses with the WI Depertment of Health Services (DHS) for immunization matching purposes. If districts opts-out of using immunization services, then student addresses is not passed to DHS.

6.0

Sending parent/guardian information when student transferres transferred to a new LEA

Because the parentUniqueId includes the LEA ID, each LEA is expected to send /parent AND /studentParentAssociation records

LEA 1: submits a /Parent record AND a /studentParentAssociation record

AND

LEA 2: submits a /Parent record AND a /studentParentAssociation record

7.0

Updating parent/guardian information for a student

There is an Ed-Fi issue when SIS vendors do a POST->GET->DELETE->POST on /parent using the same unique id. This issue appears to be a problem for v3.4, but not for v5.2.

Instead of deleting a /parent record, vendors should update (PUT) the rcords with the changes.

...