wisedata - ed-fi integration - json mapping doc - public … · data? ed-fi # e.g. student, school,...

16
WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public MAPPINGS VER DATA CATEGORY REQ DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types) To look up meta data values, you will need credentials to the WISEdata sandbox (http://dpi.wi.gov/wisedata/ven dors/contact-us). Here is a short video that shows how to obtain meta data via Swagger (http://screencast.com/t/zF4BV Q8ug) Choice Req? Public Requirement P#1.0 STUDENT Y Always required /student id string The unique identifier of the resource Resource 'id' not passed on POST. Y Same as Choice P#1.0 STUDENT Y Always required /student studentUniqueId string School enrolling the Student This is WISEid. WISEids must be loaded into the SIS prior to sending transactions to the API. WI DPI L1 Edit: This must be a valid WISEid or the SIS will receive and error right back along with any other level one errors (invalid descriptors, etc.);Recommended SIS UI edit: require this value before sending data to the API Y Same as Choice P#1.0 STUDENT Y Always required /student sexType string Person's gender See Meta data column /sexTypes Y Same as Choice P#1.0 STUDENT Y Always required /student birthDate date-time The month, day, and year on which an individual was born Recommended SIS UI edit: birthDate not a future date Y Same as Choice P#1.0 STUDENT N Always Required /student economicDisadvantaged boolean An indication of inadequate financial condition of an individual''s family, as determined by family income, number of family members/dependents, participation in public assistance programs, and/or other characteristics considered relevant by federal, state, and local policy. NEDM: Economic Disadvantaged Status, Y Same as Choice P#1.0 STUDENT N Always Required /student schoolFoodServicesEligibilityDescript or string A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table., See Meta data column; Ideally in SIS business rules, require this value if 'economicDisadvantaged' = Y. /schoolFoodServicesEligibilityDe scriptor, Types Y Same as Choice

Upload: nguyenbao

Post on 24-Jul-2018

232 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENT Y Alwaysrequired

/student id string The unique identifier of theresource

Resource 'id' not passed on POST. Y Same asChoice

P#1.0 STUDENT Y Alwaysrequired

/student studentUniqueId string School enrolling the Student This is WISEid. WISEids must beloaded into the SIS prior tosending transactions to the API.WI DPI L1 Edit: This must be avalid WISEid or the SIS will receiveand error right back along withany other level one errors (invaliddescriptors, etc.);RecommendedSIS UI edit: require this valuebefore sending data to the API

Y Same asChoice

P#1.0 STUDENT Y Alwaysrequired

/student sexType string Person's gender See Meta data column /sexTypes Y Same asChoice

P#1.0 STUDENT Y Alwaysrequired

/student birthDate date-time The month, day, and year on whichan individual was born

Recommended SIS UI edit: birthDatenot a future date

Y Same asChoice

P#1.0 STUDENT N AlwaysRequired

/student economicDisadvantaged boolean An indication of inadequatefinancial condition of anindividual''s family, as determinedby family income, number offamily members/dependents,participation in public assistanceprograms, and/or othercharacteristics considered relevantby federal, state, and local policy.NEDM: Economic DisadvantagedStatus,

Y Same asChoice

P#1.0 STUDENT N AlwaysRequired

/student schoolFoodServicesEligibilityDescriptor

string A unique identifier used as PrimaryKey, not derived from businesslogic, when acting as Foreign Key,references the parent table.,

See Meta data column; Ideally inSIS business rules, require thisvalue if 'economicDisadvantaged'= Y.

/schoolFoodServicesEligibilityDescriptor, Types

Y Same asChoice

Page 2: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENT N ConditionallyRequired

/student dateEnteredUS date-time For students born outside of theU.S., the date the student enteredthe U.S.,

Pass for students born outside ofthe US; Recommended SIS UIedit: dateEnteredUS <=dateOfBirth

Y Same asChoice

P#3.0 STUDENT N ConditionallyRequired

/student(studentCharacteristicsarray)

characteristics array An unordered collection ofstudentCharacteristics. This entityrepresents an individual for whominstruction, services and/or careare provided in an early childhood,elementary or secondaryeducational program under thejurisdiction of a school, educationagency or other institution orprogram. A student is a personwho has been enrolled in a schoolor other educational institution. ,

See Meta data column fordescriptor values; only value thatneeds to be passed in array isdescriptor(string);beginDate,endDateordesignatedByaren't requiredat this time;SATA(state assessment type -alternative) - If student is takingan 'Alternate' student assessmentthenHomeless - if student is homeless.Migrant -if student has a currentcertificate of eligibility.Immigrant -if student meets thedefinition as immigrant underTitle III. As of 2016.07.19 -'Negligent and Deliquent' wasoriginally on this list but isremoved now. It will appear inthe UAT 'sandbox' until adeployment removes it.

/studentCharacteristicDescriptorFor Public, four morecharacterictics have been added(see column I for details).Modifications to CharacteristicDescriptor in Ed Fi to reflectadditions for public available inUAT 'sandbox' as of 2016.07.14

Y(For

choicecharacteristicsdescriptor onlySATA

had tobe

passedand it

willcontinu

e toremain

thesame)

Modificationsfor Public

Page 3: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENT N ConditionallyRequired

/Students (Languages array) languages array languages(array[studentLanguage]): Anunordered collection ofstudentLanguages. Language(s) theindividual uses to communicate.,studentLanguage {languageDescriptor (string): Aunique identifier used as PrimaryKey, not derived from businesslogic, when acting as Foreign Key,references the parent table.,uses(array[studentLanguageUse]): Anunordered collection ofstudentLanguageUses. Adescription of how the language isused (e.g. Home Language, NativeLanguage, Spoken Language).}studentLanguageUse {languageUseType (string): Aunique identifier used as PrimaryKey, not derived from businesslogic, when acting as Foreign Key,references the parent table.}

Rule - Required only for Studentswith English LanguageProficiency between 1 and 5Rule - Need to passlanguageDescriptor (string) andlanguageUseType (string).LanguageDescriptor propertyuses Descriptor andlanguageusetype uses Typevalues referenced in the Metadata columnRule - Only the students' 'Nativelanguage' LanguageuseTypeshould be submittedRule - Required only for Studentswith English Language Proficiencybetween 1 and 5Note - The business use is tocapture the 'Native Language' of astudent who has ELP between 1to 5. Since there is no direct wayto capture this data, it shouldcome through an array where theLanguage (StudentLanguage) isNative (LanguageUseType)

/LanguageDescriptorAvailable in UAT 'sandbox' as of2016.07.14/LanguageuseTypes - availableon Ed Fi currently under Types

N New

P#3.0 STUDENT N ConditionallyRequired

/student limitedEnglishProficiencyDescriptor string This descriptor defines theindications that the student hasbeen identified as Limited EnglishProficient or English Proficient bythe Language ProficiencyAssessment Committee (LPAC).The map is required.

See Meta data column2016.07.19: it was in questionwhether the location of thisproperty would change. It willstay where it is. Same as originaldeploy for Choice.

/limitedEnglishProficiencyDescriptor

Y Same asChoice

P#1.0 STUDENT Y Alwaysrequired

/student hispanicLatinoEthnicity boolean An indication that the individualtraces his or her origin or descentto Mexico, Puerto Rico, Cuba,Central and South America, andother Spanish cultures, regardlessof race. The term, ""Spanishorigin,"" can be used in addition to""Hispanic or Latino.""

Y Same asChoice

Page 4: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENT N Alwaysrequired

/student (studentRace array) races array An unordered collection ofstudentRaces. This entityrepresents an individual for whominstruction, services, and/or careare provided in an early childhood,elementary, or secondaryeducational program under thejurisdiction of a school, educationagency or other institution orprogram. A student is a personwho has been enrolled in a schoolor other educational institution.

See Meta data column;raceType(string) can be one ormany values; pass in, for example,'Asian', 'White'

/raceTypes Y Same asChoice

P#1.0 STUDENT Y Alwaysrequired

/student firstName string A name given to an individual atbirth, baptism, or during anothernaming ceremony, or through legalchange. NEDM: First Name

Y Same asChoice

P#1.0 STUDENT Y Alwaysrequired

/student lastSurname string The name born in common bymembers of a family. NEDM: LastName/Surname

Y Same asChoice

P#1.0 STUDENT N ConditionallyRequired

/Students (Visas array) visas array visas (array[studentVisa]): Anunordered collection ofstudentVisas. Describe the types ofVisa that a non-U.S. citizen studentholds

Rule - Only required when aStudent has a 'Visa' Required forforeign exchange students

/visaTypes N New

P#1.0 STUDENT N ConditionallyRequired

/students wiDpiStudentResidentEducationOrganizatioinReference

reference wiDpiStudent {wiDpiStudentResidentEducationOrganizationReference(educationOrganizationReference,optional): A reference to therelated EducationOrganizationresource.} The district in which the studentresides

Note - This is the LEA Id (eg.school district). Required for non-district 2R charter schools. Forother districts, if not provided,the resident district will beidentified as the submittingdistrict

N New

P#1.0 STUDENTSCHOOL

Y Alwaysrequired

/studentSchoolAssociations id string Unique identifier of the resource. Resource 'id' not passed on POST. Y Same asChoice

Page 5: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSCHOOL

Y Alwaysrequired

/studentSchoolAssociations schoolReference reference A reference to the related Schoolresource

Reference to the /schoolresource; a GET on /schools isrequired to have data needed for/school resource. This could beimplemented as a periodic call topopulate the local SIS db.

Y Same asChoice

P#1.0 STUDENTSCHOOL

Y Alwaysrequired

/studentSchoolAssociations studentReference reference A reference to related Studentresource

Reference to the /studentresource

Y Same asChoice

P#1.0 STUDENTSCHOOL

Y Alwaysrequired

/studentSchoolAssociations entryDate date-time The month, day, and year on whichan individual enters and begins toreceive instructional services in acampus for the school year.NEDM: School Entry Date NEDM:LEA Entry Date.

Recommended SIS UI edit: entryDateshould not be before date of birth;exitWithdrawDate can't be beforeentryDate or exitWithdrawDateshouldn't be populated unless thereis an entryDate

Y Same asChoice

P#1.0 STUDENTSCHOOL

N ConditionallyRequired

/studentSchoolAssociations exitWithdrawTypeDescriptor string A unique identifier used as PrimaryKey, not derived from businesslogic, when acting as Foreign Key,references the parent table.,

See Meta data column;Recommended SIS UI edit:ifexitWithdrawDate must beexitWithdrawTypeDescriptor andvice-versa

/exitWithdrawTypeDescriptors Y Same asChoice

P#1.0 STUDENTSCHOOL

N ConditionallyRequired

/studentSchoolAssociations exitWithdrawDate date-time The month, day, and year of thefirst day after the date of anindividual's last attendance at aschool (if known), the day onwhich an individual graduated, orthe date on which it becomesknown officially that an individualleft school or the date a studentdied whichever comes first. Forcontinuing students, the exit dateis the last day of attendance forthe school year.

Recommended SIS UI edit:exitWithdrawDate should not bebefore dateOfBirth;exitWithdrawDate can't be beforeentryDate or exitWithdrawDateshouldn't be populated unless thereis an entryDate; if exitWithdrawDatemust be exitWithdrawTypeDescriptorand vice-versa

Y Same asChoice

P#1.0 STUDENTSCHOOL

N ConditionallyRequired

/studentSchoolAssociations schoolYearTypeReference reference Identifier for a school year See Meta data column; WI DPI L1Edit:this year should match theyear in the URL you are calling inyour JSON request. If theschoolYearTypeReference doesn'tmatch the year in the URL, youwill receive a level one error backfrom the API

/schoolYearTypes Y Same asChoice

Page 6: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSCHOOL

Y Alwaysrequired

/studentSchoolAssociations entryGradeLevelDescriptor string The grade level or primaryinstructional level at which astudent enters and receivesservices in a school or aneducational institution during agiven academic session

See Meta data column /gradeLevelDescriptors Y Same asChoice

P#1.0 STUDENTSCHOOL

N Alwaysrequired

/studentSchoolAssociations primarySchool boolean Indicates if a given enrollmentrecord should be considered theprimary record for a student.

Y Same asChoice

P#1.0 STUDENTSCHOOL

N ConditionallyRequired

/studentSchoolAssociation wiDpiStudentSchoolAssociation array Wisconsin DPIstudentSchoolAssociationextensionwiDpiStudentSchoolAssociation {schoolReference(schoolReference): A reference tothe related School resource.,studentReference(studentReference): A referenceto the related Student resource.,wiDpiSsaProgramScheduleType(string, optional): Indicator ofschool day schedule for Four yearold and Five year oldKindergartners}

Rule - Only for students in gradelevel K4 or KG. K4 students mustuse one of the K4 codes, while KGstudent must use one of the KGcodes.Note - programscheduletype isnot an out of box Ed Fi dataproperty. It has been added tothe core/StudentSchoolAssociation andshould be sent as an array underWiDPIStudentSchoolAssociation.

/wiDpiProgramScheduleTypesAvailable in UAT 'sandbox' as of2016.07.14.

N New

P#1.0 STUDENTSCHOOL

N ConditionallyRequired

/studentSchoolAssociations repeatgradeindicator boolean An indicator of whether thestudent is enrolling to repeat agrade level, either by failure or anagreement to hold the studentback.,

Rule- Only required whenCompleted School Term is ' Y'.Note- When a student ispromoted to the next grade level,the repeat grade level indicatorwould be a ' N'. This is opposite towhat the SIS is used to sendingearlier (which was promotionindicator). Please check to makesure to avoid any confusion

N New

P#1.0 STUDENTSCHOOLWISC

Y Alwaysrequired

/studentSchoolAssociationWisconsinExt

id string The unique identifier of theresource

Y Same asChoice

Page 7: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSCHOOLWISC

Y Alwaysrequired

/studentSchoolAssociationWisconsinExt

schoolid integer School enrolling the Student Note: part of db constraint:PK_StudentSchoolAssociationWisconsinExt PRIMARY KEY CLUSTERED(StudentUSI, SchoolId,EntryDate)

Y Same asChoice

P#1.0 STUDENTSCHOOLWISC

Y Alwaysrequired

/studentSchoolAssociationWisconsinExt

studentUniqueId string A unique alpha-numeric codeassigned to a student

This is WISEid. WISEids must beloaded into the SIS prior tosending transactions to theAPI;Note:part of db constraint:PK_StudentSchoolAssociationWisconsinExt PRIMARY KEYCLUSTERED (StudentUSI,SchoolId,EntryDate)

Y Same asChoice

P#1.0 STUDENTSCHOOLWISC

Y Alwaysrequired

/studentSchoolAssociationWisconsinExt

entryDate date-time The entry date associated with thestudent's enrollment

Note: part of db constraint:PK_StudentSchoolAssociationWisconsinExt PRIMARY KEY CLUSTERED(StudentUSI, SchoolId,EntryDate)

Y Same asChoice

P#1.0 STUDENTSCHOOLWISC

N ConditionallyRequired

/studentSchoolAssociationWisconsinExt

expectedTransferEducationalOrganizationReference

reference A reference to the relatedEducationOrganization resource

The agency (in this case a districtor CMO ('16)) the student isexpected to transfer in caseswhere the subsequent enrollmenthas not yet occurred but theexpected transfer district isknown. This property is necessarybecause some districts fail tosubmit enrollment in a timelymanner and/or a district hasissued a second id for a studenteven though they already haveone. This process helps identifythe issues. Once the property isgathered, it is used to notify thereceiving district to prevent 'lostor unclaimed' dropouts. This iscritical to capture data whichcould incorrectly turn into adropout.

Y Same asChoice

Page 8: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSCHOOLWISC

N ConditionallyRequired

/studentSchoolAssociationWisconsinExt

expectedTransferSchoolReference reference A reference to the related Schoolresource

The expected school the studentis expected to transfer in caseswhere the subsequent enrollmenthas not yet occurred but theexpected transfer school isknown. This is captured for thesame reason asexpectedTransferEducationOrganizationReference but provides anadditional level of detail.Rule - This should be providedonly when the student isTransfering within the samedistrict. Not required when astudent is Transfering to adifferent district

Y Same asChoice

P#1.0 STUDENTSCHOOLWISC

N ConditionallyRequired

/studentSchoolAssociationWisconsinExt

completedSchoolTerm boolean Indicates whether or not a studentcompleted the school term duringthe school enrollment period. It iscollected for every studentenrollment record and is notrelated to graduation. A studentcould have more than oneenrollment record for a schoolyear

Y Same asChoice

P#1.0 STUDENTSCHOOLWISC

N ConditionallyRequired

/studentSchoolAssociationWisconsinExt

actualDaysAttendance number Aggregate value that captures theactual daysin attendance for astudent.

Up to SIS on sending frequency,but recommended at least onceper day; value can be a decimal;attendance rules for WI see this:https://uawisedataapi.dpi.wi.gov/EdFiSwagger/#!/attendanceEventCategoryDescriptors/getAttendanceEventCategoryDescriptorsAll_get_0 ; Recommended SIS UIedit:actualDaysAttendance can'tbe greater thanpossibleDaysAttendance

Y Same asChoice

Page 9: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSCHOOLWISC

N ConditionallyRequired

/studentSchoolAssociationWisconsinExt

possibleDaysAttendance number Aggregate value that capture thepossible daysin attendance for astudent

Up to SIS on sending frequency,but recommended at least onceper day; value can be a decimal;attendance rules for WI see this:https://uawisedataapi.dpi.wi.gov/EdFiSwagger/#!/attendanceEventCategoryDescriptors/getAttendanceEventCategoryDescriptorsAll_get_0 ; Recommended SIS UIedit:actualDaysAttendance can'tbe greater thanpossibleDaysAttendance

Y Same asChoice

P#1.0 STUDENTSCHOOLWISC

N ConditionallyRequired

/studentSchoolAssociationWisconsinExt(studentSchoolAssociationWisconsinExtReceivingService array)

receivingServices array An unordered collection ofstudentSchoolAssociationWisconsinExtReceivingServices;countDateNameType= The countdate name for the student status(e.g 3rd FriSept);countDateReceivingServiceType= The status of the studentduring the specific count date (e.g.Present)

Need to passcountDateNameType(string)andcountDateReceivingServiceType(string). Both properties useType values referenced in theMeta data column;Note:this canbe sent as null if the studentenrollment entryDate(/studentSchoolAssociationentryDate) is post 3rd Friday ofSept and Oct 1 childcount. Thereshouldn't be overlappingenrollment periods for primaryenrollment. If we receive this fora student an L2 error will displayto the district in the WISEdataPortal.

/countDateNameTypes;/countDateReceivingServiceTypes

Y Same asChoice

P#1.0 STUDENTPROGRAM

Y Alwaysrequired

/studentProgramAssociations id string The unique identifier of theresource

N New

P#1.0 STUDENTPROGRAM

Y Alwaysrequired

/studentProgramAssociations educationorganizationreference reference A reference to the relatedEducationOrganization resource.,educationOrganizationReference {educationOrganizationId(integer): EducationOrganizationIdentity Column,}

N New

Page 10: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTPROGRAM

Y Alwaysrequired

/studentProgramAssociations programreference reference A reference to the related Programresource.,programReference {educationOrganizationId(integer): EducationOrganizationIdentity Column,type (string): Key for Program,name (string): The formal name ofthe program of instruction,training, services or benefitsavailable through federal, state, orlocal agencies.,link (link, optional): Represents ahyperlink to the related programresource.}

Note - CCDEB and State Schoolsare expected to submit studentsto WISEdata rather than theresident district as was done inISES.Rule- If a/StudentProgramAssociation isPosted for a specific 'Program', itmeans the student is participatingin the program.Rule - Need to passeducationOrganizationId(integer),type (string), name(string)Rule - TheeducationOrganizationId is alwaysDPI - 48856Rule - To POST a particularprogram, the correct Type andName combination has to be sentfrom the below listThe following are differentPrograms created.1. Type - cocirricular, Name - ELLServed(An indicator of whether thestudent who is an EnglishLanguage Learner (i.e. EnglighLanguage Proficiency code 1-5) isserved in English languageinstruction educational programsdesigned for English LanguageLeaners (ELLs).)2. Type - cocirricular , Name -Coordinated Early InterveningServices(Any student who benifitted fromCEIS Services reported in theannual special education budget)3. Type -regular education ,Name - Third Party - CESA(Third party entity providingservices to the student under acontract with the district)4. Type -regular education ,

/Program Types N New

Page 11: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

Name - Third Party - Other(Third party entity providingservices to the student under acontract with the district)Note -1. The SIS will only be able to GETthe Type from 'ProgramTypes'.Since these specific programs arecreated at DPI level, GET on'name' cannot be performed.Please make sure to use theabove list of Programs (Type andName) to submit (POST) throughProgramReference under/StudentProgramAssociations.2. Once a Program is POSTED, tosubmit another Program, theentire /StudentProgramAssociation hasto be submitted with a thedesired Program (Type and name)from the list above underProgram Reference in the JSON

P#1.0 STUDENTPROGRAM

Y Alwaysrequired

/studentProgramAssociations studentReference reference A reference to the related Studentresource.,studentReference {studentUniqueId (string): Aunique alpha-numeric codeassigned to a student.,}

N New

P#1.0 STUDENTPROGRAM

Y Alwaysrequired

/studentProgramAssociations begindate date-time The month, day, and year on whichthe Student first received services.,

N New

P#1.0 STUDENTPROGRAM

N ConditionallyRequired

/studentProgramAssociations enddate date-time The month, day, and year on whichthe Student exited the Program orstopped receiving services.,

N New

Page 12: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTACADEMICRECORD

Y ConditionallyRequired

/studentAcademicRecord id string The unique identifier of theresource

Resource 'id' not passed on POST;not needed for K-8 schools

Y Same asChoice

P#1.0 STUDENTACADEMICRECORD

Y ConditionallyRequired

/studentAcademicRecord educationOrganizationReference reference A reference to the relatedEducationOrganization resource.

Reference to the /schoolresource.Note:This should be a school, nota district.; not needed for K-8schools

Y Same asChoice

P#1.0 STUDENTACADEMICRECORD

Y ConditionallyRequired

/studentAcademicRecord schoolYearTypeReference reference A reference to the relatedSchoolYearType resource

See Meta data column;notneeded for K-8 schools

/schoolYearTypes Y Same asChoice

P#1.0 STUDENTACADEMICRECORD

Y ConditionallyRequired

/studentAcademicRecord studentReference reference A reference to the related Studentresource

Reference to the /studentresource;not needed for K-8schools

Y Same asChoice

P#1.0 STUDENTACADEMICRECORD

Y ConditionallyRequired

/studentAcademicRecord termDescriptorId string The term for the session during theschool year.

See Meta data column; send 'A'as of version 1.0;not needed forK-8 schools

/termDescriptor Y Same asChoice

Page 13: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTACADEMICRECORD

N ConditionallyRequired

/studentAcademicRecord(studentAcademicRecordDiplomaarray)

diplomas array An unordered collection ofstudentAcademicRecordDiplomas.This educational entity representsthe cumulative record of academicachievement for a student;diplomaType= The type ofdiploma/credential that isawarded to a student inrecognition of his/her completionof the curricularrequirements;diplomaAwardDate=The month, day, and year on whichthe student met graduationrequirements and was awarded adiploma;achievementCategoryDescriptor= categories studentachievement.

Need to passdiplomaType(string),diplomaAwardDate (date-time) andachievementCategoryDescriptor(string); both type and descriptorlists referenced in Meta datacolumn; for diplomaType validvalues to send are: 'RegularDiploma', 'High SchoolEquivalency Credential OtherThan GED', 'OtherDiploma';achievementCategoryDescriptor =where diplomaType =‘Other Diploma’ then setachievementCategoryDescriptor =‘Certificate Earned’ WherediplomaType in (‘RegularDiploma’, ’High SchoolEquivalency Credential OtherThan GED’ then setachievementCategoryDescriptor =‘Diploma Earned’;RecommendedSIS UI edit: diplomaAwardDateshouldn't be prior to dateOfBirth;if diplomaType, should be adiplomaAwardDate and vice-versa;not needed for K-8 schools

/diplomaTypes;/achievementCategoryDescriptor

Y Same asChoice

P#1.0 STUDENTSPECIALEDUCATION

Y Alwaysrequired

/studentSpecialEducationProgramAssociation

Id string The unique identifier of theresource

Resource 'id' not passed on POST. N New

P#1.0 STUDENTSPECIALEDUCATION

Y Alwaysrequired

/studentSpecialEducationProgramAssociation

educationorganizationreference reference A reference to the relatedEducationOrganizationresource.,The educationorganization where the student isparticipating in or receiving theprogram serviceseducationOrganizationReference {educationOrganizationId(integer): EducationOrganizationIdentity Column.,}

Rule - The ID for school in theStudentSchoolAssociation recordwhich includes the ‘Begin Date’ ofthis association

N New

Page 14: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSPECIALEDUCATION

Y Alwaysrequired

/studentSpecialEducationProgramAssociation

programreference reference A reference to the related Programresource.,programReference {educationOrganizationId(integer): EducationOrganizationIdentity Column,type (string): Key for Program,name (string): The formal name ofthe program of instruction,training, services or benefitsavailable through federal, state, orlocal agencies.,link (link, optional): Represents ahyperlink to the related programresource.}

Rule - The program type ' SpecialEducation' is always expectedRule - The program name 'SpecialEducation' is always expectedRule - The ID for school in theStudentSchoolAssociation recordwhich includes the ‘Begin Date’ ofthis association. This is same asthe EducationOrganizationId

/ProgramType N New

P#1.0 STUDENTSPECIALEDUCATION

Y Alwaysrequired

/studentSpecialEducationProgramAssociation

studentReference reference studentReference {studentUniqueId (string): Aunique alpha-numeric codeassigned to a student.,link (link, optional): Represents ahyperlink to the related studentresource.}

Reference to the /studentresource

P#3.0 STUDENTSPECIALEDUCATION

N ConditionallyRequired

/studentSpecialEducationProgramAssociation

wiDpiFapeResponsibleSchoolReference

reference A reference to the related Schoolresource. School in LEAResponsible for FAPE is a schoollevel Agency Key. School whichholds FAPE Accountability per theIEP or the ISP

Rule-School in LEA Responsiblefor FAPE is required only for IDEAeligible student (IDEA Eligibility isY)Note- This is the school Id

N New

P#1.0 STUDENTSPECIALEDUCATION

Y Alwaysrequired

/studentSpecialEducationProgramAssociation

begindate date-time The month, day, and year on whichthe Student first received specialeducation services under theassociated IEP or ISP.

N New

P#1.0 STUDENTSPECIALEDUCATION

N Alwaysrequired

/studentSpecialEducationProgramAssociation

enddate date-time The month, day, and year on whichthe Student exited the specialeducation program or stoppedreceiving services.

N New

Page 15: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#1.0 STUDENTSPECIALEDUCATION

N Alwaysrequired

/studentSpecialEducationProgramAssociation

ideaeligibility boolean Indicator of the eligibility of thestudent to receive specialeducation services according tothe Individuals with DisabilitiesEducation Act (IDEA). For 2016-17,expected to by ‘True’; thisresource should be sent only forIDEA Eligible students.

N New

P#1.0 STUDENTSPECIALEDUCATION

N ConditionallyRequired

/studentSpecialEducationProgramAssociation

iepreviewdate date-time The date of the last IEP review Rule - This date may be in thecurrent or immediately previousschool year

N New

P#1.0 STUDENTSPECIALEDUCATION

N Alwaysrequired

/studentSpecialEducationProgramAssociation

iepbegindate date-time The effective date of theassociated IEP or ISP.

Rule - This date may be in thecurrent or immediately previousschool year.

N New

P#1.0 STUDENTSPECIALEDUCATION

N Alwaysrequired

/studentSpecialEducationProgramAssociation

iependdate date-time The end date of the associated IEPor ISP

Rule - his date may be in thecurrent or next school year.

N New

P#1.0 STUDENTSPECIALEDUCATION

Y Alwaysrequired

/studentSpecialEducationProgramAssociation

specialeducationsettingdescriptor string This descriptor defines the majorinstructional setting (more than 50percent of a student's specialeducation program).

Note - Educational Environmentcode list of types to include all 3to 5 and age 6 to 21 settings. SISwas only used to sending 6 to 21age settings earlier

/SpecialEdSettingDescriptorAvailable in UAT 'sandbox' as of2016.07.14

N New

Page 16: WISEdata - Ed-Fi Integration - JSON Mapping Doc - Public … · DATA? ED-FI # e.g. Student, School, etc. Ed-Fi DPI JSON Resource JSON Property JSON Data Type Ed-Fi Definition Rules

WISEdata - Ed-Fi Integration -JSON Mapping Doc - Public

MAPPINGS

VER DATACATEGORY

REQDATA?

ED-FI

# e.g.Student,School,etc.

Ed-Fi DPI JSON Resource JSON Property JSON DataType

Ed-Fi Definition Rules & Notes - SIS Meta data (Descriptors / Types)To look up meta data values, youwill need credentials to theWISEdata sandbox(http://dpi.wi.gov/wisedata/vendors/contact-us). Here is a shortvideo that shows how to obtainmeta data via Swagger(http://screencast.com/t/zF4BVQ8ug)

ChoiceReq?

PublicRequirement

P#3.0 STUDENTSPECIALEDUCATION

N AlwaysRequired

/studentSpecialEducationProgramAssociation(wiDpiStudentSpecialEducationProgramAssociationDisabilities array)

wiDpiStudentSpecialEducationProgramAssociationDisabilities

array An unordered collection ofstudentDisabilities. This entityrepresents an individual for whominstruction, services and/or careare provided in an early childhood,elementary or secondaryeducational program under thejurisdiction of a school, educationagency or other institution orprogram. A student is a personwho has been enrolled in a schoolor other educational institution.,wiDpiStudentSpecialEducationProgramAssociationDisability {disabilityDescriptor (string): Aunique identifier used as PrimaryKey, not derived from businesslogic, when acting as Foreign Key,references the parent table.,disabilityDiagnosis (string,optional): A description of thedisability diagnosis.,orderOfDisability (integer,optional):disabilityDeterminationSourceType(string, optional): Key for DisabilityDetermination Source Type

See Meta data column fordisability descriptors; valuesneeded in array aredisabilityDescriptor (string) andorderOfDisability (integer); fororderOfDisability pass Reporting,Other

/disabilityDescriptorsAvailable in EdFi Currently underDescriptors

N(For

choicedisabili

typroperty was apart of/Stude

ntsResource andit will

continue to bein thesame)

Modificationsfor Public

P#3.0 STUDENTSPECIALEDUCATION

N ConditionallyRequired

/studentSpecialEducationProgramAssociation

wiDpiParentPlacedPrivate boolean Identifies if a student is receivingPrimary education services from aPrivate school and Specialeducation services from a publicschoolIndication of a studentplaced by a parent or guardian inprivate school, Parentally PlacedPrivate, who receives specialeducation or related services fromthe submitting district that meetstate standards under a serviceplan (34 CFR 300.452--300.462).

Only required for students whoare IDEA Eligible

N New