Versions Compared

Version Old Version 7 New Version Current
Changes made by

Jaidaa Shafaei

heather.kluck

Saved on

Key

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

...

(blue star) This endpoint is NOT expected from Choice schools.

Ed-Fi Tech Docs: https://edfi.atlassian.net/wiki/spaces/EDFICERT/pages/23702573/v5+StaffAssociation+StaffSchoolAssociation, https://edfi.atlassian.net/wiki/spaces/EDFICERT/pages/23695494/StaffAssociation+StaffSchoolAssociation (2024/25 SY and prior)

...

Data Properties:

Expand
titleClick here to view all data properties under the /staffSchoolAssociation endpoint:

#

Property Name

Data Type

Public (Required/ Optional/ Conditional)

Choice (Required/ Optional/ Conditional)

Business Definition

Data Element Page

1.0

schoolReference. schoolId

integer

REQ'D

NOT REQ'D

The identifier assigned to a school.

https://dpi.wi.gov/wise/data-elements/schoolid

2.0

staffReference. staffUniqueId

string

REQ'D

NOT REQ'D

A unique alphanumeric code assigned to a staff.

https://dpi.wi.gov/wise/data-elements/WISEid

3.0

calendarReference. calendarCode

string

OPT

NOT REQ'D

The identifier for the Calendar.

N/A

4.0

calendarReference. schoolYear

integer

OPT

NOT REQ'D

The identifier for the school year associated with the Calendar.

https://dpi.wi.gov/wise/data-elements/school-year

5.0

calendarReference. schoolId

integer

OPT

NOT REQ'D

The identifier assigned to a school.

6.0

schoolYearTypeReference. schoolYear

integer

OPT

NOT REQ'D

Key for School Year

https://dpi.wi.gov/wise/data-elements/school-year

7.0

academicSubjectDescriptor

string

OPT

NOT REQ'D

The academic subjects the individual is eligible to teach.

https://dpi.wi.gov/wise/data-elements/academic-subject

NOTE: This list includes descriptors for SIS (CEDS & DPI namespace) and Assessment vendors (Ed-Fi namespace).

8.0

gradeLevelDescriptor

string

OPT

NOT REQ'D

The grade levels the individual is eligible to teach.

https://dpi.wi.gov/wise/data-elements/grade-level

9.0

programAssignmentDescriptor

string

REQ'D

NOT REQ'D

The name of the program for which the individual is assigned; for example: Regular education Title I-Academic Title I-Non-Academic Special Education Bilingual/English as a Second Language.

N/A

...

Expand
titleClick here to view all the descriptors for /staffSchoolAssociation endpoint:

Namespace

Code Value

Short Description

Long Description

uri://ed-fi.org/ProgramAssignmentDescriptor

Other

Other

Other

Bilingual/English as a Second Language

Bilingual/English as a Second Language

Bilingual/English as a Second Language

Regular Education

Regular Education

Regular Education

Special Education

Special Education

Special Education

Title I-Non-Academic

Title I-Non-Academic

Title I-Non-Academic

Title I-Academic

Title I-Academic

Title I-Academic

uri://dpi.wi.gov/ProgramAssignmentDescriptor

O

Other

Other

uri://dpi.wi.gov/GradeLevelDescriptor

KG

5 year old Kindergarten

5 year old Kindergarten

PK

Pre-Kindergarten

Pre-Kindergarten

01

First Grade

First Grade

02

Second Grade

Second Grade

03

Third Grade

Third Grade

04

Fourth Grade

Fourth Grade

05

Fifth Grade

Fifth Grade

06

Sixth Grade

Sixth Grade

07

Seventh Grade

Seventh Grade

08

Eighth Grade

Eighth Grade

09

Ninth Grade

Ninth Grade

10

Tenth Grade

Tenth Grade

11

Eleventh Grade

Eleventh Grade

12

Twelfth Grade

Twelfth Grade

K4

4-year-old Kindergarten

4-year-old Kindergarten

uri://ceds.ed.gov/AcademicSubjectDescriptor

 

1

English Language and Literature

English

2

Mathematics

Math

3

Life and Physical Sciences

Science

4

Social Sciences and History

Social Studies

5

Visual and Performing Arts

Fine Arts

22

Miscellaneous

Miscellaneous Required Credits Not Covered Above – any subject (not electives)

24

World Languages

World Language

uri://dpi.wi.gov/AcademicSubjectDescriptor

27

Health

Health

28

Physical Education

Physical Education

29

Computer Science

Computer Science

30

Career Technical Education

Career Technical Education

31

Personal Finance

Personal Finance

32

Recommended Elective

Recommended Elective

...

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 member present in the district within 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.

SIS vendors/LEAs should provide the programAssignmentDescriptor as configured in the SIS.

  • If the SIS vendor designates values such as Bilingual/English as a Second Language, Regular Education, Special Education, Title I-Non-Academic, or Title I-Academic, those values should be sent.

  • If the SIS does not designate one of the values listed above, vendors may send either 'Other' or 'Regular Education.'

  • Note that the value ‘Other’ can be used with either the DPI or Ed-Fi namespace:

    • uri://dpi.wi.gov/ProgramAssignmentDescriptor#O

    • uri://ed-fi.org/ProgramAssignmentDescriptor#Other

POST on /staffSchoolAssociation:

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

schoolReference: schoolId": 7525

staffReference: staffUniqueId": "1001001001"

2.0

Create a StaffSchoolAssociation for a staff record that does member NOT exist present in the district within 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. Add the staff in the WISEid System and wit wait for validation to run before posting the /staffSchoolAssociation.

OR

create

(if you have implemented the Staff Identity Integration)

  1. Create or search for the staff member in WISEid using the Identity 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 record, then delete the old graduationPlan staffSchoolAssociation record.

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

PUT on /staffSchoolAssociation

4.0

Delete the StaffSchoolAssociation

To delete an enrollment recordThe staffSchoolAssociation can be deleted without requiring the deletion of any associated child records first.

DELETE on /staffSchoolAssociation

...

Expand
titleJSON sample for /staffSchoolAssociation:
Code Block
languagejson
{
    "programAssignmentDescriptor": "uri://ed-fi.org/ProgramAssignmentDescriptor#OtherProgramAssignmentDescriptor#Regular Education",
    "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"
        }
    ]
}

...