The ideal real-time workflow would be:

1. When having end-users add a WISEid in SIS first verify they have all WISEid required fields of Local Person ID,  First Name, Last Name, Birthdate, Gender, Race/Ethnicity – if a required field is missing, then don’t allow them to continue further and prompt the user to supply missing fields to proceed.

2. If the Person has Multiple Birth Status = Y, and there is no WISEid in your system, then end-users should always go to a real-time match review screen to pick possible options or create a new WISEid from data (SIS should not rely on auto-matching when Multiple Birth Status = Y).

3. If no possible match result is found from the /identities and Multiple Birth Status ≠ Y, then do a CREATE of a new WISEid.

4. If only one record is returned as a possible match from /identities and Multiple Birth Status ≠ Y, then auto-match

5. If more than one record is returned from /identities, then the SIS vendor should display a real-time manual match review with all results to allow the LEA to either select a WISEid or opt to create a new WISEid after reviewing and finding no results. 

Potentially the SIS will be doing a batch matching process that mirrors the current WISEid upload processing. Instead of Match Reviews happening in bulk in WISEid they would happen in bulk in the SIS match/review tool.  This option is available since many vendors already have for other states, but in our opinion, that is not the best-recommended practice.  

The ideal batch workflow would be:

1. Verify the record has all WISEid required fields of Local Person ID,  First Name, Last Name, Birthdate, Gender, Race/Ethnicity – if a required field is missing, then don’t allow the records to be processed further.

2. If a Person has Multiple Birth Status = Y, and there is no WISEid in your system, then end-users should always go to match review (SIS should not rely on auto-matching when Multiple Birth Status = Y).

3. If no possible match results from /identities, and Multiple Birth Status ≠ Y, then do a CREATE of new WISEids.

4. If only one record is returned as a possible match from /identities and Multiple Birth Status ≠ Y, then auto-match.

5. If any more than one record is returned from /identities, then the SIS vendor should display results for the LEA to review manually in real-time.

REQUEST

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/{id}

• HTTP METHOD: GET

• BODY: None

RESPONSE

• NOTES:

  • The fields in red are specific to WI DPI implementation of Ed-Fi Identity.

  • The fields Email and LocalPersonId will not be returned if your ApiClient Key doesn’t have access to the corresponding district

• BODY:

IdentityResponse {

UniqueId (string, optional),

Score (number, optional),

LastSurname (string, optional),

FirstName (string, optional),

MiddleName (string, optional),

GenerationCodeSuffix (string, optional),

SexType (string, optional),

BirthDate (string, optional),

BirthOrder (integer, optional),

BirthLocation (Location, optional)

MultipleBirthIndicator (bool, option)

IsHispanicLatino (bool, option)

RaceKey (string, option) 

RaceCodes (array[string], option), A, B, I, P, W

Locals (array(Local), optional),

Names (array[Name], optional), other names

ParentGuardianNames (array[Name], optional),

Enrollments (array[Enrollment], optional), : Does not include DOC/ DHS.

InactiveUniqueIds (array[string], option), Old (duplicate) UniqueIds for the student which were merged to the current UniqueId }

Location {

City (string, optional),

StateAbbreviation (string, optional),

InternationalProvince (string, optional),

Country (string, optional),

County (string, optional), }

Local {

EducationOrganizationId (integer, optional): it’s highly recommended that vendors send the EducationOrganizationId with the request.

LocalPersonId (string, optional), : A string uniquely identifying the student for the Vendor Software

Description (string, optional), : A description of the person local row key - ex. Manually created wise id

Email (string, optional),

TypeDescription (string, optional), : Either Student or Teacher

WiseSecureRoleDescription (string, optional) : A role federation role Ex Student or Teacher }

Name {

FirstName (string, optional),

MiddleName (string, optional),

LastSurname (string, optional) }

Enrollment {

SchoolYear (integer, optional),

School (SchoolReference, optional),

EntryGradeLevelDescriptor (string, optional),

EntryDate (date, optional),

ExitWithdrawDate (date, optional) }

SchoolReference {

SchoolId (integer, optional),

NameOfInstitution (string, optional),

LocalEducationAgency (LocalEducationAgencyReference, optional) }

LocalEducationAgencyReference {

LocalEducationAgencyId (integer, optional),

NameOfInstitution (string, optional) }

EXAMPLE

REQUEST:

URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/1001052923

RESPONSE:

BODY:

REQUEST

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/find/

• HTTP METHOD: POST

• BODY: UniqueIds(array[string], optional) : An array of UniqueId (aka WiseIds)

• NOTES:

  • Passing in a list of UniqueIds will perform a search for each one and return a result of 1 or no matches for each UniqueId.

  • 100 UniqueId limit when searching.  If the limit is exceeded, an error message is returned stating the request has exceeded the limit.

RESPONSE

• NOTES:

  • The fields in red are specific to WI DPI implementation of Ed-Fi Identity.

  • The fields Email and LocalPersonId will not be returned if your ApiClient Key doesn’t have access to the corresponding district.

  • SearchKey is returned, which is required when using the create endpoint. This serves the purpose of requiring a search before creating a new WISEid person record.

  • The SearchKey is only valid for a create using the same values (FirstName, LastName, Birthdate, etc.)  and with the same API Key/Secret.

  • The SearchKey expires after 10 mins.

  • The find is limited to 100 WISEids

• BODY:

IdentitySearchResponse {

Status (string, optional) = ['Incomplete' or 'Complete'],

SearchKey (guid, optional),

SearchResponses (array[IdentitySearchResponses], optional) }

IdentitySearchResponses {

Responses (array[IdentityResponse], optional) }

IdentityResponse {

UniqueId (string, optional),

Score (number, optional),

LastSurname (string, optional),

FirstName (string, optional),

MiddleName (string, optional),

GenerationCodeSuffix (string, optional),

SexType (string, optional),

BirthDate (string, optional),

BirthOrder (integer, optional),

BirthLocation (Location, optional),

MultipleBirthIndicator (bool, option)

IsHispanicLatino (bool, option)

RaceKey (string, option) 

RaceCodes (array[string], option), A, B, I, P, W

Locals (array(Local), optional),

Names (array[Name], optional), other names

ParentGuardianNames (array[Name], optional),

Enrollments (array[Enrollment], optional),  : Does not include DOC/ DHS,

InactiveUniqueIds (array[string], option), Old (duplicate) UniqueIds for the student which were merged to the current UniqueId }

Location {

City (string, optional),

StateAbbreviation (string, optional),

InternationalProvince (string, optional),

Country (string, optional),

County (string, optional), }

Local{

EducationOrganizationId (integer, optional): it’s highly recommended that vendors send the EducationOrganizationId with the request.

LocalPersonId (string, optional), : A string uniquely identifying the student (or staff) for the Vendor Software (aka LocalPersonRowKey)

Description (string, optional), : A description of the person local row key - ex. Manually created wise id

Email (string, optional),

TypeDescription (string, optional), : Either Student or Teacher

WiseSecureRoleDescription (string, optional) : A role federation role Ex Student or Teacher }

Name {

FirstName (string, optional),

MiddleName (string, optional),

LastSurname (string, optional) }

Enrollment {

SchoolYear (integer, optional),

School (SchoolReference, optional),

EntryGradeLevelDescriptor (string, optional),

EntryDate (date, optional),

ExitWithdrawDate (date, optional) }

SchoolReference {

SchoolId (integer, optional),

NameOfInstitution (string, optional),

LocalEducationAgency (LocalEducationAgencyReference, optional) }

LocalEducationAgencyReference {

LocalEducationAgencyId (integer, optional),

NameOfInstitution (string, optional) }

EXAMPLE

REQUEST

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/find

• BODY ["1001052923"]

RESPONSE

• BODY

REQUEST

• NOTES

  • Passing only UniqueId will perform will result in 1 or no matches returned.

  • FirstName, LastSurname, and Birthdate are required (unless UniqueId is present).

  • Values provided by all name fields are case insensitive.

  • The following fields affect score: UniqueId, FirstName, LastSurname, MiddleName, Birthdate, Suffix (Exact Match), LocalPersonId, EducationOrganizationId.

  • The following fields boost score: 

    • 6 point boost for an exact match on FirstName, LastSurname, and Birthdate.

    • 3 point boost for an exact match on LastSurname and Birthdate.

  •  The EducationOrganizationId is highly recommended and it helps determine if Email and LocalPersonId should be returned for ApiKeys that are associated with more than one Education Organization. If the EducationOrganizationId field is omitted, not valid, or is not authorized for the associated ApiKey, then the default Education Organization associated with the ApiKey will be used to determine if the Email and LocalPersonId should be returned. The fields Email and LocalPersonId are only returned if they are associated with final determining EducationOrganizationId. 

  • When implementing Identity V3.x if a new student has Multiple Birth indicator = Y (in the SIS/vendor application database) always send the student to match review (your UI that displays possible matches) so that twins with similar names won’t be combined into the same or wrong person by auto-matching. You want to give the user the ability to create a new WISEid in this scenario.  

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/search

• HTTP METHOD: POST

• BODY

IdentitySearchRequests (array[IdentitySearchRequest], optional)

IdentitySearchRequest{

UniqueId (string, optional),

LastSurname (string, Required),

FirstName (string, Required),

BirthDate (string, Required),

MiddleName (string, optional),

GenerationCodeSuffix (string, optional),

SexType (string, optional),

LocalPersonId (string, optional), A string uniquely identifying the student (or staff) for the Vendor Software (aka LocalPersonRowKey)

EducationOrganizationId (integer, optional): It’s highly recommended that vendors send the EducationOrganizationId with the request. The the EducationOrganizationId field helps determine if Email and LocalPersonId should be returned for ApiKeys that are associated with more than one Education Organization. If this field is omitted, not valid, or is not authorized for the associated ApiKey, then the default EducationOrganizationId associated with the ApiKey will be used to determine if the Email and LocalPersonId should be returned. The fields Email and LocalPersonId are only returned if they are associated with final determining EducationOrganizationId.

RESPONSE

• NOTES:

  • The fields in red are specific to WI DPI implementation of Ed-Fi Identity.

  • The fields Email and LocalPersonId are only returned if they are associated with final determining EducationOrganizationId (see additional notes above about the request field EducationOrganizationId).

  • SearchKey is returned, which is required when using the create endpoint. This serves the purpose of requiring a search before creating a new WISEid person record.

  • The SearchKey is only valid for a CREATE when using the same request parameters that were passed in the SEARCH (FirstName, LastName, Birthdate, etc.) and with the same API Key/Secret.

  • The SearchKey expires after 10 mins.

  • CONFIDENCE SCORE LOGIC

    • If one exact or very close match results from a search (excludes synonyms) based on the core search fields provided in the request match, then a score of 100 will be generated. So 100 is a Best match - exact or very close match.

    • If more than one exact or very close match exists based on the core search fields provided, a score of 80 + (Lucene score * .1) will be generated for each match. So any score >80 and <100 is in this range and is a Good match.

    • Results that are not an exact or very close match to the core search fields but are > 3 in the Lucene scoring system will be given a score of 50 + (Lucene score * .1). So any score >50 and <80 is in this range and is a OK match.

    • Results having a Lucene score less than 3 will not show up in the results (no changes from the original scoring rules. Anything with a score less than 50 is omitted).

    • The sort order can be done from either score OR order of results returned by Identity API as they are the same descending order

    • Only the top 30 score matches per person maximum will be returned.  Even if scores are above the cut off they will be omitted if not in the top 30 results for that person.

    • If a person has a Multiple Birth indicator = Y always send to match review no matter what you get above.  Could be a twin with a similar name.

• BODY

IdentitySearchResponse {

Status (string, optional) = ['Incomplete' or 'Complete'],

SearchKey (guid, optional),

SearchResponses (array[IdentitySearchResponses], optional) }

IdentitySearchResponses {

Responses (array[IdentityResponse], optional) }

IdentityResponse {

UniqueId (string, optional),

Score (number, optional), Anytime more than one possible match is returned, DO NOT automate the selection of a WISEid based on score or other logic. An LEA user needs to be presented with the possible matches and then manually select(see the confidence score logic above)

LastSurname (string, optional),

FirstName (string, optional),

MiddleName (string, optional),

GenerationCodeSuffix (string, optional),

SexType (string, optional),

BirthDate (string, optional),

BirthOrder (integer, optional),

BirthLocation (Location, optional)

MultipleBirthIndicator (bool, option)

IsHispanicLatino (bool, option)

RaceKey (string, option) 

RaceCodes (array[string], option), A, B, I, P, W

Locals (array[Local], optional),

Names (array[Name], optional), other names

ParentGuardianNames (array[Name], optional),

Enrollments (array[Enrollment], optional),  : Does not include DOC/ DHS,

InactiveUniqueIds (array[string], option), Old (duplicate) UniqueIds for the student which were merged to the current UniqueId }

Location {

City (string, optional),

StateAbbreviation (string, optional),

InternationalProvince (string, optional),

Country (string, optional),

County (string, optional) }

Local {

EducationOrganizationId (integer, optional): it’s highly recommended that vendors send the EducationOrganizationId with the request.

LocalPersonId (string, optional), : A string uniquely identifying the student for the Vendor Software

Description (string, optional), : A description of the person local row key - ex. Manually created wise id

Email (string, optional),

TypeDescription (string, optional), : Either Student or Teacher

WiseSecureRoleDescription (string, optional) : A role federation role Ex Student or Teacher }

Name {

FirstName (string, optional),

MiddleName (string, optional),

LastSurname (string, optional) }

Enrollment {

SchoolYear (integer, optional),

School (SchoolReference, optional),

EntryGradeLevelDescriptor (string, optional),

EntryDate (date, optional),

ExitWithdrawDate (date, optional) }

SchoolReference {

SchoolId (integer, optional),

NameOfInstitution (string, optional),

LocalEducationAgency (LocalEducationAgencyReference, optional) }

LocalEducationAgencyReference {

LocalEducationAgencyId (integer, optional),

NameOfInstitution (string, optional) }

EXAMPLE

REQUEST:

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/search

• BODY:

RESPONSE:

• BODY:

REQUEST

• NOTES:

  • SearchKey from SEARCH endpoint call is required when using the CREATE endpoint. This serves the purpose of requiring a search before creating a new WISEid person record.

  • The SearchKey is only valid for a CREATE when using the same request parameters that were passed in the SEARCH (FirstName, LastName, Birthdate, etc.) and with the same API Key/Secret.

  • The SearchKey expires after 10 mins.

  • The fields in red are specific to WI DPI implementation of Ed-Fi Identity.

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/

• HTTP METHOD: POST

• BODY

IdentityCreateRequest {

SearchKey: (GUID, required),

LastSurname (string, required),

FirstName (string, required),

MiddleName (string, optional),

GenerationCodeSuffix (string, optional),

SexType (string, required),

BirthDate (string, required),

BirthOrder (integer, optional),

BirthLocation (Location, optional),

RaceCodes (array[string], required ), A, B, I, P, W

MultipleBirthIndicator (bool, optional)

IsHispanicLatino: (bool, required),

Locals (array[Local], required),

Names (array[Name], optional), other names

ParentGuardianNames (array[Name], required) : At least one 'Parent/Guardian' record is required for each person record when they have a 'Local Person ID Key Type' that equals 'Student' }

Location {

City (string, optional),

StateAbbreviation (string, optional),

InternationalProvince (string, optional),

Country (string, optional),

County (string, optional) }

Local {

EducationOrganizationId (integer, optional): it’s highly recommended that vendors send the EducationOrganizationId with the request. This should be the LocalEducationAgencyId and not the SchoolId.

LocalPersonId (string, required), : A string uniquely identifying the student (or staff) for the Vendor Software (aka LocalPersonRowKey)

Description (string, optional), : A description of the person local row key - ex. Manually created wise id

Email (string, optional),

TypeDescription (string, required), : Either Student or Teacher

WiseSecureRoleDescription (string, optional) : A role federation role Ex Student or Teacher }

Name {

FirstName (string, optional),

MiddleName (string, optional),

LastSurname (string, optional) }

RESPONSE

• NOTES:

  • The fields highlighted in red are specific to WI DPI implementation of Ed-Fi Identity.

  • The fields email and LocalPersonId will not be returned if your ApiClient Key doesn’t have access to the corresponding district.

• BODY:

UniqueId (string, optional): This is the same as a WISEid

EXAMPLE

REQUEST:

• URL: https://apps.dpi.wi.gov/EdFiWebApi/identity/v2/2023/identities/

• BODY:

RESPONSE:

• BODY: 1001052923