Skip to end of metadataGo to start of metadata

Lab Prerequisites

Attendees at these sessions will be doing hands-on exercises using the Ed-Fi ODS/API deployed in a VM on AWS, and you will need to provide your own laptop and have access to an AWS Cloud tenancy.

Note: Even though AWS has promotions for free accounts and/or free credits you may need to input a credit card.

There is only one prerequisite for this lab:

  • 1: Have access to an AWS Cloud tenant.

Lab Instructions

1) Login to (

2) Click on the top menu "Services" (#1) and then click on "EC2" (#2).

3) On the left menu panel click on "AMIs".


4) The public image lives in the "Ohio" availability zone. So make sure you select "Ohio" from the top right menu (#1). Then on the search bar change the dropdown to be "Public images" (#2). On the search input box type edfi and hit enter (#3). You should see an AMI called "v32 EdFi ODS ..." right click it and select the "Launch" option (#4).

5) You will be redirected to the "Choose an Instance Type" screen. We recommend you select a machine that at least has 2 vCPUs and 8GB of ram (or higher). If not the machine will be very slow.

Select a "t2.large" instance or higher (#1). Click on the "Review and Launch" button.

6) you will be presented with the "Step7: Review Instance Launch" screen. Review and make sure under the storage tab it has 100 GB for the disk (#1). Then proceed to click the "Launch" button (#2).


7) A modal will popup asking for a certificate. Choose "Create a new key pair" name it edfi and then click Download Key Pair. Note: It is very important to keep this downloaded certificate in a secure place.


8) You will be presented with the "Launch Status" screen. Click on the "View Instances" button at the bottom right of the screen.

9) You will be presented with the "Instances" page. Here you will see your running instance. Wait until it says "Status Checks 2/2".

10) Use the public IP to connect to the instance using RDP (Remote Desktop Connection). Click on the windows icon on your task bar and type RDP and then enter.

11) Use the following credentials to login to the VM:

  •  User: Administrator
  • Password: eL@.8WWgBGMCcmYAWHQ!$g23phYdnDiX

12) You are now successfully logged in to the VM contianing a v3.2 Ed-Fi ODS API and all its artifacts.

Exploring the Ed-Fi ODS API:

Exploring Databases

1) Open SSMS (Sql Server Management Studio) by clicking on the icon on the task bar.


2) Connect to the local instance by just clicking connect.


3) Expand the databases on the left panel (Object Explorer). You will see a list of all databases. At this point you can expand and explore all tables and objects in the Ed-Fi ODS databases.


Exploring IIS and the Available Sites

1) Open IIS (Internet Information Services) by clicking on the icon on the task bar.


2) Expand the server by clicking on the arrow on the left. (Expand all websites and virtual directories) (#1)

3) Click on the application that says api (#2)

4) On the right "Actions" panel click on browse 443 (#3). It will open a Chrome Browser window. Click on Browse as Guest. Then go back to the IIS window and click on Browse 443 again. This time it should open a second tab with the api URL.



5. Without closing the Chrome browser you can return to IIS and explore the other applications by selecting them and clicking on Browse 443.

6. Open the "docs" application. This is the production swagger. Click on the resources link on the right.


7) Authorize your session: Click on the authorize button and use the following credentials.

        client_id: UgM3A3u8Ievr

        client_secret: WnJRHDpam1BO6tGM36Pt7w05

Then click on the "Authorize" button and the inputs should switch to asterisks. This means you are authorized. At this point you can click the "Close" button.

8) Execute the students request: Scroll all the way to the bottom of the screen and locate the students request. Click on the arrow on the right to expand it (#1). Then proceed to click on the "GET" request (#2) to expand the options. Click on the "Try it out" button (#3) and scroll to the bottom until you see a big blue button that says "Execute". 

Click on the "Execute" button (#1). You should see a loading animation and then on the results below you will see an array of students (#2). You can continue to explore the rest of the Ed-Fi ODS API endpoints.

You can explore the rest of the applications on that server.



Exploring the Ed-Fi ODS API through PostMan

1) Open Postman. Click on the icon on the task bar.


2) Execute a authorization request: On the left panel expand the folder EdFi v3.1.1 and select the "POST Get Auth Token" request (#1). You can choose what environment you want to use by using the environment dropdown that has been pre-configured with both a sandbox and a production environment. (#2). Once you have selected an environment proceed to click on the "Send" button (#3). Once the request finishes you should see in the results panel a response that contains the access_token.


3) Execute the students request: On the left pane select the "GET Get Students" (#1) request and click the send button (#2). The results panel should show an array of students. (#3)

Note: you have to have authenticated first by running the "POST Get Auth Token" request and getting an access_token as described above. 


  • No labels