Vendor Resources

The purpose of this page is to provide vendors with resources that will be helpful for development purposes. 

2017-18 CEPI Component Mapping - This link will take you to a Google Spreadsheet repository that displayes the alignment of the Ed-Fi API to the CEPI Components and elements

2018-19 CEPI Component Mapping - This link will take you to a Google Spreadsheet repository that displays the alignement of the Ed-Fi API to the CEPI Components and elements.

2019-20 CEPI Component Mapping - This link will take you to a Google Spreadsheet repository that displays the alignement of the Ed-Fi API to the CEPI Components and elements.

Changed Record Queries - This document provides details on the changed record queries functionality and how it is enable in v3.1.  MiDataHub has implemented this process in our v2.4 specifications.  Also see the Using the Changed Record Queries document for more details.

Composite Specifications Documents - These documents provide details on how to use the Food Service, Library and Transportation composites.  

Ed-Fi Descriptor Values - Updated 5-3-2019

Extended XML Specifications - These are the Ed-Fi XML specifcation (XSD) files that have been extended with for use in the Michigan Data Hub.  These include all state reporting extentions.  These are updated as of June 7, 2017.

Michigan Ed-Fi 2.4 ODS API SDK - Build 2019.24.5 (Updated 7/10/2019) This software development kit will assist vendors in connecting to, reading from, and writing to our data hubs for integration with district data.  This version is based on the Ed-Fi 2.4 final and has the Michigan MSDS extensions for the 2018-19 school year.  This version also provides additional capabilities for Food Service, Library and Transportation composites as well as PATCH update capability.

Extensions to the Michigan Ed-Fi Environment - This is the documentation for the extensions made to the Ed-Fi Specifications in Michigan, including those made for MSDS, FID, REP, EEM, transportation and staff achievements.Launchpad Implementation - This document indicates how to configure a client application to show an icon on the MiDataHub Launchpad.

MiDataHub SSO Instructions for Vendors (Relying Party Trust for Client Applications)
This document walks through the steps to connect a Client Application to the MiDataHub Single Sign-On (SSO) so that it can authenticate users that come in through MiDataHub. 

M-STEP Mapping Document - This document contains information on how the M-STEP data is mapped so that vendors/systems can pull that data reliably via the Ed-Fi API.

UIC Services - This document provides details on calling the Identities API, which can be used to perform a Unique Identification Code (UIC) lookup.  If configured by the district, the API may also generate a new UIC if a student doesn’t have one.

Vendor Interoperabilty Development Gameplan - This document discussess the steps need to have a vendor system use the MiDataHub SSO.

Vendor System Configuration Steps for SSO Usage - This document discussess the steps need to have a vendor system use the MiDataHub SSO.

Web Services Sandbox

The following pages are used for testing of the web services