Vendor Resources

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

Product Catalog Entry Data Collection Form – Data collected on this form will be used to generate the product catalog entry for your service.

2021-22 CEPI Component Mapping v3 - This link will take you to a Google Spreadsheet repository that displays the alignment of the v3.1.1 Ed-Fi API to the CEPI Components and elements for the 2021-22 school year.

2022-23 CEPI Component Mapping v3 - NEW This link will take you to a Google Spreadsheet repository that displays the alignment of the v3.1.1 Ed-Fi API to the CEPI Components and elements for the 2022-23 school year.

Change Queries – MiDataHub implements the change queries functionality in our Ed-Fi v3.1-based API implementation.  Ben Meyers from DLP provided an overview on a recent webinar (click for video) and also shared out a Postman file that can be used to walk through the example scenario demonstrated. 

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.  

Digital Equity Data Collection - This document provides the questions and values to be used for submitting the data within the studentIndicator array of the studentEducationOrganizationAssociation resource.

Ed-Fi Descriptor Values v3.1 - NEW - Updated 8-3-2021 – These are the descriptor values for use in Ed-Fi v3.1.

Ed-Fi Resource Status List - NEW - This provides a list of API resources with a status of whether they are populated or not.  This is helpful for those vendors looking to consume data from MiDataHub.

Enrollment Transfer Documentation-Draft - This is a draft version of the documentation for the enrollment transfer process.

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

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.

Identity Services API Documentation - UPDATED (May 24, 2023)This document provides details on calling the Identities API, which can be used to perform a Unique Identification Code (UIC) lookup and can also be used to get Portable Records (Snack-pack) information.  

Launchpad Implementation - This document indicates how to configure a client application to show an icon on the MiDataHub Launchpad.

Michigan Ed-Fi ODS API SDK – Latest - With each build the datahub posts all updates and changes to the sdk. Two versions of the sdk are posted with release candidates delineated with an rc postfix:
1) EdFi.OdsApi.Sdk.Src.MI311. is the standard generation from the ed-fi tooling.
2) Michigan.Ods.Sdk.Src.MI311. is a more customized version, attempting to bridge the gap between 2.4 and 3.1.

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.

PSAT and SAT Mapping Document - This document indicates how the PSAT and SAT data are mapped so that vendors/systems can pull that data reliably via the Ed-Fi API.

Vendor Interoperabilty Development Gameplan - This document discusses the various ways to integrate with the MiDataHub ecosystem..

Web Services Sandbox

The following pages are used for testing of the web services