WI DPI WISEdata Ed-Fi Docs
/staff
- Jaidaa Shafaei
- heather.kluck
As of 2024-25 SY, staff data may be obtained from the WISEdata API via a GET request on the /staff endpoint.
The order of posting JSON is /staff, /staffEducationOrganizationEmploymentAssociation, and /staffSectionAssociation. If the staff is new to a district, without posting the staff section record (/staffSectionAssociation) you cannot do a GET on /staff.
This endpoint is NOT expected from Choice schools.
Ed-Fi Tech Docs: https://techdocs.ed-fi.org/display/EDFICERT/v3+StaffAssociation+%3E+Staff
Data Properties:
# | Property Name | Data Type | Public (Required/ Optional/ Conditional) | Choice (Required/ Optional/ Conditional) | Business Definition | Data Element Page |
1.0 | staffUniqueId | string | REQ’D | NOT REQ’D | A unique alphanumeric code assigned to a staff. This is the staff's WISEid. Valid WISEids must be loaded into the vendor's application prior to sending transactions to the API. | |
2.0 | birthDate | string | REQ’D | NOT REQ’D | The month, day, and year on which an individual was born.
| |
3.0 | firstName | string | REQ’D | NOT REQ’D | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. | Student/Staff Name (Legal and Other Names)
|
4.0 | middleName | string | OPT | NOT REQ’D | A secondary name given to an individual at birth, baptism, or during another naming ceremony. | |
5.0 | lastSurname | string | REQ’D | NOT REQ’D | The name borne in common by members of a family. | |
6.0 | generationCodeSuffix | string | OPT | NOT REQ’D | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). | |
7.0 | maidenName | string | OPT | NOT REQ’D | The individual's maiden name. | N/A |
8.0 | hispanicLatinoEthnicity | boolean | REQ’D | NOT REQ’D | An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, "Spanish origin," can be used in addition to "Hispanic or Latino." | |
9.0 | races | array | OPT | NOT REQ’D | An unordered collection of staffRaces. The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. The way this data element is listed, it must allow for multiple entries so that each individual can specify all appropriate races. |
|
10.0 | raceDescriptorEntity ID | string | OPT | NOT REQ’D | The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. The way this data element is listed, it must allow for multiple entries so that each individual can specify all appropriate races. | |
11.0 | identificationCodes | array | REQ’D | NOT REQ’D | An unordered collection of staffIdentificationCodes. A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity. |
|
12.0 | staffIdentificationSystemDescriptor | string | REQ’D | NOT REQ’D | A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a staff member. Value is: EntityId | |
13.0 | identificationCode | string | REQ’D | NOT REQ’D | A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity. | N/A |
14.0 | sexDescriptor | string | REQ’D | NOT REQ’D | Person’s gender. Valid options are: M = Male, F = Female, or X = Non-Binary | |
16.0 | electronicMails | array | OPT | NOT REQ’D | An unordered collection of staffElectronicMails. The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. |
|
17.0 | electronicMailTypeDescriptor | string | OPT | NOT REQ’D | The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)O | |
18.0 | electronicMailAddress | string | OPT | NOT REQ’D | The electronic mail (e-mail) address listed for an individual or organization. | |
19.0 | otherNames | array | OPT | NOT REQ’D | An unordered collection of staffOtherNames. Other names (e.g., alias, nickname, previous legal name) associated with a person. | N/A |
20.0 | otherNameTypeDescriptor | string | OPT | NOT REQ’D | The types of alternate names for an individual | N/A |
21.0 | firstName | string | OPT | NOT REQ’D | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. | N/A |
22.0 | middleName | string | OPT | NOT REQ’D | A secondary name given to an individual at birth, baptism, or during another naming ceremony. | N/A |
23.0 | lastSurname | string | OPT | NOT REQ’D | The name borne in common by members of a family. | N/A |
24.0 | generationCodeSuffix | string | OPT | NOT REQ’D | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). | N/A |
Use Cases:
# | Use Case Title | Use Case Description | What to Submit/retrieve |
---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
---|---|---|---|
1.0 | Sending the name for staff who use an alternative name to identify themselves (e.g. Jimmy for James) | For staff, who use a nickname such as a shortened version of their legal name, their alternative name may be preferred over their legal name. However, this alternative name should NOT be reported to WISEdata. While not required, LEAs may report the alternative names in WISEid Upload File manually or inside the WISEid App under Other Names. | Not submitted to WISEdata
|
2.0 | Retrieving staff data from the WISEdata API | The the /staff endpoint is populated with person data submitted through the WISEid application. The staff Local Person ID will also be populated in this endpoint (only the staff persons who have a local Person ID will be populated). SIS vendors are able to download the staff data from the /staffs endpoint. DPI strongly encourages SIS vendors to do a GET on /staffs to retrieve staff data that has been submitted to the WISEid application.
| GET on /staffs |
JSON Sample:
{
"staffUniqueId": "5522664321",
"firstName": "Lloyd",
"middleName": "Test",
"lastSurname": "Jagger",
"birthDate": "2074-03-14",
"multipleBirthStatus": "",
"generationCodeSuffix": "",
"dateEnteredUS": "",
"visas": [{
"visaDescriptor": ""
}],
"birthCity": "Madison",
"birthCountryDescriptor": "uri://dpi.wi.gov/CountryDescriptor#US",
"birthStateAbbreviationDescriptor": "uri://ed-fi.org/StateAbbreviationDescriptor#WI"
}
Add label
Wisconsin Department of Public Instruction