🆕 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.
...
Expand |
---|
title | Click here to view all data properties under the /staff endpoint: |
---|
|
# | 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. | https://dpi.wi.gov/wise/data-elements/WISEid | 2.0 | birthDate | string | REQ’D | NOT REQ’D | The month, day, and year on which an individual was born. | https://dpi.wi.gov/wise/data-elements/dateofbirth | 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. | https://dpi.wi.gov/wise/data-elements/student-name | 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. | | 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." | N/A | 9.0 | LocalPersonId | string | REQ’D | NOT REQ’D | A string uniquely identifying the person for the Vendor Software. | | 10.0 | SexType | string | REQ’D | NOT REQ’D | Person’s gender. Valid options are: M = Male) , F = Female, or X = Non-Binary | Gender | 11.0 | TypeDescription | string | REQ’D | NOT REQ’D | Either Student or Teacher | |
|
...
Use Cases:
Expand |
---|
title | Click here to view all the use cases pertaining to the /staff endpoint: |
---|
|
# | 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 | Sending the name for a staff who uses the legal name from the birth certificate to identify themselves | A legal name will be reported under the /staff endpoint and will be displayed in WISE applications. The staff name (FirstName, middleName, LastSurName, generationCodeSuffix) must be the same in three places: 1- on /Student endpoint 2- WISEid Person Upload/Download CSV file process 3- on /identities in the Staff Identity Integration | POST on /staff firstName: Lloyd, middleName: Test, lastSurname: Jagger, generationCodeSuffix: Sr | 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 |
---|
|
JSON Sample:
Expand |
---|
title | Click here to view view the JSON sample for posting the /student endpoint: |
---|
|
Code Block |
---|
{
"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"
} |
|
...