/
Software Testing Resources

WI DPI WISEdata Ed-Fi Docs

Software Testing Resources

This content is archived.
Replaced by Tools and Resources for Development and Testing, added 7/1/26
Learn more

In order to test, vendors will need a REST client that can authenticate via OAuth 2. There are many free and paid REST clients that you can use for testing. The two clients we use are listed below. Both are free.

  • SoapUI: Besides supporting SOAP requests, it also has a REST client. //The World’s Most Popular API Testing Tool | SoapUI  

  • RestClient 2: This is a FireFox extension. According to the developer, they also have an extension for Safari and for Chrome. Developer website: restclient.net/  

You will likely need a web traffic tracer/debugger. There are a number of web debuggers out there. The REST clients above (SoapUI or RestClient2) will show web traffic when you make a request. The web debuggers can be handy when creating requests via the DPI-provided WISEdata Ed-Fi REST SDK or a proprietary Ed-Fi REST client.

Swagger

Swagger is accessible only in the Sandbox/UAT environment and is intentionally not available in production. This approach helps protect sensitive data, maintain system performance, and prevent unintended changes or disruptions in the live environment. It also aligns with best practices for security and compliance by ensuring that testing and discovery tasks are done safely in a non-production environment.

Swagger is a tool used to document and interact with REST APIs defined using the OpenAPI Specification. The Ed-Fi Alliance has provided Using the Online Documentation.

To "GET" with Swagger, you'll generally be using it to: 1) explore an API's functionality, and 2) test its operations, including "GET" requests. Here's a breakdown of how to use Swagger to "GET" data from an API:

  1. Access Swagger. Links are available in the Ed-Fi Credential tool and on our Development Resources page. NOTE: Swagger links may vary by school year.

  2. Authorize Your Key and Secret unlock your data and establishes access to the API. When your Secret appears ***hashed*** this indicates that the Secret was shared with the vendor and data is flowing. DPI does not maintain Secrets

  3. Explore the API. Once in Swagger UI, browse the API's endpoints. Once you’ve found the endpoint and look for operations (usually denoted by HTTP methods like GET, POST, PUT, DELETE). Focus on the "GET" operations to retrieve data.

  4. Test a GET operation.

    • Click the "Try it out" button. This activates the interactive testing mode for the selected GET operation. 

    • Provide parameters (if required). Some GET operations require parameters (e.g., an ID, a search term). Enter the required parameters in the designated fields. 

    • Click "Execute". This sends the GET request to the API endpoint with the specified parameters. 

    • View the response. Swagger UI displays the API's response, including the status code (e.g., 200 for success), response headers, and the response body (the data returned by the API). 

WISEhome

The WISEhome portal grants access to WISE applications such as the WISEdata Portal and Ed-Fi Credential. For access visit Sandbox (UAT) and Production Environments Access

WISEid: File Layouts and Templates

The WISEstaff File Layouts and Templates page on the Wisconsin Department of Public Instruction (DPI) website provides essential resources for vendors and Local Education Agencies (LEAs) to ensure accurate data submission. Key contents include: File Layouts, Downloadable CSV templates, Assignment Codes and Security Best Practices.

 

 

 

Wisconsin Department of Public Instruction