WI DPI WISEdata Ed-Fi Docs

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This association provides the contact information of the staff associated with the education organization.

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

Ed-Fi Tech Docs: https://edfidocs.blob.core.windows.net/$web/handbook/v5.2/index.html#/StaffEducationOrganizationContactAssociationc18a3a12-5f61-4cc6-b1d8-1bfeac21992c


Data Properties:

 Click here to view all data properties under the /staffEducationOrganizationContactAssociations endpoint:

#

Property Name

Data Type

Public (Required/ Optional/ Conditional)

Choice (Required/ Optional/ Conditional)

Business Definition

Data Element Page

1.0

contactTitle*

string

REQ'D

NOT REQ'D

The title of the contact in the context of the education organization

NA

2.0

educationOrganizationReference*:

educationOrganizationId

integer

REQ'D

NOT REQ'D

The identifier assigned to an education organization. This could be either a School ID or an LEA ID, but the School ID is preferred.

https://dpi.wi.gov/wise/data-element/edorgid

3.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

4.0

electronicMailAddress

string

REQ'D

NOT REQ'D

The email for the contact associated with the education organization

https://dpi.wi.gov/wise/data-elements/email-address

5.0

contactTypeDescriptor

string

OPT

NOT REQ'D

Indicates the type for the contact information

NA

6.0

addressTypeDescriptor

string

OPT

NOT REQ'D

The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)

NA

7.0

streetNumberName

string

OPT

NOT REQ'D

The street number and street name or post office box number of an address,

NA

8.0

city

string

OPT

NOT REQ'D

The name of the city in which an address is located.

NA

9.0

stateAbbreviationDescriptor

string

OPT

NOT REQ'D

The abbreviation for the state (within the United States) or outlying area in which an address is located.

NA

10.0

postalCode

string

OPT

NOT REQ'D

The five or nine digit zip code or overseas postal code portion of an address.

NA

11.0

telephoneNumberTypeDescriptor

string

OPT

NOT REQ'D

The type of communication number listed for an individual or organization.

NA

12.0

telephoneNumber

string

OPT

NOT REQ'D

The telephone number including the area code, and extension, if applicable.

NA


Use Cases:

 Click here to view all the use cases pertaining to the /staffEducationOrganizationAssignmentAssociation endpoint:

#

Use Case Title

Use Case Description

What to Submit/retrieve

1.0

Sending a staff member with multiple LEA associations and different email addresses

A staff member works across multiple LEAs and needs to be associated with each LEA they are working with, along with their contact information.

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

  • Either the /staffEducationOrganizationAssignmentAssociation record (this endpoint is populated from WISEid),

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

  • Or the /staff and /staffEducationOrganizationEmploymentAssociations

SIS vendors/LEAs should provide the Contact Title as configured in the SIS.

LEA 1 POST on /staffEducationOrganizationAssignmentAssociations:

contactTitle: Teacher
educationOrganizationReference:
educationOrganizationId: 7525
staffReference:
staffUniqueId: 1001001001
electronicMailAddress: "staff@LEA1.com"

LEA 2 POST on /staffEducationOrganizationAssignmentAssociations:

LEA 1 POST on /staffEducationOrganizationAssignmentAssociations:

contactTitle: Teacher
educationOrganizationReference:
educationOrganizationId: 1234
staffReference:
staffUniqueId: 1001001001
electronicMailAddress: "staff@LEA2.com"

Sending a staff member with multiple email addresses in the same LEA

A staff member has multiple email addresses (e.g., john.smith@district.edu and smithj@district.edu) and is associated with a single LEA.

POST on /staffEducationOrganizationAssignmentAssociations:

contactTitle: Teacher
educationOrganizationReference:
educationOrganizationId: 7525
staffReference:
staffUniqueId: 1001001001
electronicMailAddress: "john.smith@district.edu"

POST on /staffEducationOrganizationAssignmentAssociations:

contactTitle: Teacher
educationOrganizationReference:
educationOrganizationId: 7525
staffReference:
staffUniqueId: 1001001001
electronicMailAddress: "smithj@district.edu"

2.0

Update the staffEducationOrganizationAssignmentAssociations

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

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

PUT on /staffEducationOrganizationAssignmentAssociations

3.0

Delete the staffEducationOrganizationAssignmentAssociations

The staffEducationOrganizationAssignmentAssociation record can be deleted without requiring the deletion of any associated child records first.

DELETE on /staffEducationOrganizationAssignmentAssociations


JSON Sample:

 JSON sample for /staffEducationOrganizationAssignmentAssociation:
{
    "contactTitle": "string",
    "educationOrganizationReference": {
        "educationOrganizationId": 7525
    },
    "staffReference": {
        "staffUniqueId": "1001001001"
    },
    "electronicMailAddress": "strings"
}

  • No labels