Postman is available for download from the Postman Home Page
Step 1 - Download the Ed-Fi Boot Camp 2017 Vendor Collection and Environment
Step 2 - Click the 'Run in Postman' button
Step 3 - Choose one of the options that you are most comfortable with
Step 4 - Ensure that Postman opened and the 'Ed-Fi Boot Camp 2017 Vendor' Collection is available
Step 5 - Open the Postman Console by clicking on 'View' → 'Show Postman Console'
The Postman Console is a helpful tool to see more details about the API calls that have been sent. It also keeps the history when it is open.
Step 6 -
Expand the ‘Ed-Fi Boot Camp 2017 Vendor’ collection
Expand the ‘Authentication’ folder
Select the ‘GetOAuthCode’ operation
Step 7 - Hit the ‘Send’ button to get the auth code
Step 8 - Select the ‘GetOAuthToken’ and select ‘Body’
Step 9 - Hit the ‘Send’ button
Now you have the bearer access token
Step 10 - Click on the ‘GetAll localEducationAgencies’ and select the ‘Headers’ tab
In the Headers is where the Bearer token is sent to authorize reach request
Step 11 - Click the ‘Post Student’ and then select the ‘Headers’ tab
In addition to the Authorization header, this call will also send the content-type application/json header since it will be sending json data in the body.
Step 12 - Hit the 'Send' button
In the response headers you can find the eTag, and on the right you can see the status of 201 Created
Step 13 - Click the ‘Get By Example students’ and then select the ‘Headers’ tab
In this call, notice that the Headers only contains the Authorization this time, and the information for the studentUniqueId is sent in the url via the querystring parameter.
Step 14 - Hit the 'Send' button
In the response body you can see the “Authorization denied” message and on the right you can see the 403 Forbidden. This is because no association between the local education agency and the student has been established
Step 15 - Click the ‘Post Schools’ and then select the ‘Body’ tab
In the ‘Body’ tab is where the json is located. This is the information that will be sent to the API.
Step 16 - Hit the 'Send' button
Again we receive the eTag and the Status of ‘201 Created’
Step 17 - Click the ‘Post studentSchoolAssociations’ and then select the ‘Body’ tab
In this call, the Headers will contain the Authorization bearer token and the content-type. In the ‘Body’ tab you can see the json data that will be sent to the url at the top arrow
Step 18 - Hit the 'Send' button
Again we receive the eTag and the Status of ‘201 Created’
Step 19 - Click the ‘Get By Example students’ again
In this call, notice that the Headers only contains the Authorization this time, and the information for the studentUniqueId is sent in the url via the querystring parameter.
Step 20 - Hit the 'Send' button
This time you will receive the information for the student in the response body and the Status of ‘200 OK’
Step 21 - Find the Postman Console and Select that window from the taskbar
This is helpful because it shows the history of calls that have been made
You can also expand each call for a summary