Versions Compared

Version Old Version 6 New Version 7
Changes made by

Jaidaa Shafaei

Jaidaa Shafaei

Saved on

Key

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

...

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

#

Use Case Title

Use Case Description

What to Submit/retrieve

1.0

Create a StaffSchoolAssociation for a staff record that exists in the WISEid system

Prerequisites: The following records need to be posted to the WISEdata API before posting the /staffSchoolAssociation resource:

  • /staff

  • /staffEducationOrganizationAssignmentAssociations

When the staff is present in the district within the WISEid system, LEA/SIS can post /staffSchoolAssociation by using the staff WISEid from the /staff resource.

POST on /staffSchoolAssociation:

programAssignmentDescriptor: "uri://ed-fi.org/ProgramAssignmentDescriptor#Regular EducationProgramAssignmentDescriptor#Other",

schoolReference: schoolId": 7525

staffReference: staffUniqueId": "1001001001"

2.0

Create a StaffSchoolAssociation for a staff record that does NOT exist in the WISEid system

Prerequisites: The following records need to be posted to the WISEdata API before posting the /staffSchoolAssociation resource:

  • /staff

  • /staffEducationOrganizationAssignmentAssociations

When a staff member is NOT present in the district within the WISEid system, the LEA/SIS must follow these steps to successfully post the /staffSchoolAssociation:

  1. Create Add the staff in the WISEid System and wit for validation to run before posting the /staffSchoolAssociation.

OR

  1. create or search for the staff member in WISEid using the Identity API.AP

  2. Post the /staff resource.

  3. Post the /staffEducationOrganizationEmploymentAssociation resource.

POST on /staff:

POST on /staffEducationOrganizationAssignmentAssociations

POST on /staffSchoolAssociation

3.0

Update the StaffSchoolAssociation

If the updated data property is a primary key, then vendors will need to insert a new graduationPlan record, then delete the old graduationPlan record.

If the updated data property is NOT a primary key, then vendors would simply update the data property for an existing graduationPlan record.

PUT on /staffSchoolAssociation

4.0

Delete the StaffSchoolAssociation

To delete an enrollment record, all child records??.

DELETE on /staffSchoolAssociation

...

Expand
titleJSON sample for /staffSchoolAssociation:
Code Block
languagejson
{
    "programAssignmentDescriptor": "uri://ed-fi.org/ProgramAssignmentDescriptor#Regular EducationProgramAssignmentDescriptor#Other",
    "calendarReference": {
        "calendarCode": "",
        "schoolId": 7525,
        "schoolYear": 2025
    },
    "schoolReference": {
        "schoolId": 7525
    },
    "schoolYearTypeReference": {
        "schoolYear": 2025
    },
    "staffReference": {
        "staffUniqueId": "1001001001"
    },
    "academicSubjects": [
        {
            "academicSubjectDescriptor": "uri://ceds.ed.gov/AcademicSubjectDescriptor#Miscellaneous"
        }
    ],
    "gradeLevels": [
        {
            "gradeLevelDescriptor": "uri://dpi.wi.gov/GradeLevelDescriptor#02"
        }
    ]
}

...