AEFIS API 1.0
Introduction
AEFIS Application Programming Interface (API) provides access to your AEFIS data for use in other applications. API supports main business objects such as program outcomes, course outcomes, course syllabus, assessment results, survey results, and others, and continues to expand with new functionality and additional use-cases.
This documentation provides the basic information for the AEFIS API and aims to give a quick start. For additional information and use of AEFIS API for a specific use-case, please contact [email protected]. Once your institution is configured to use the API, you can use the <institution url>/api URL for documentation and a sandbox environment for the API.
AEFIS API v1.0 supports only data read and supports GET operations only and returns structured JSON data.
API supports access to all the main business objects within AEFIS. Using the API, you can:
- Get lists of AEFIS business objects
- Send search/filter parameters to get to the right data set
- Scroll through the result set to get all the items in the data set
- Get details on the object using an object identifier returned by AEFIS
- Pull report data from AEFIS
AEFIS API 1.0 Setup
AEFIS API 1.0 uses Basic Authentication. To access the API, AEFIS will provide an API key and secret for your institution using a secure channel. Make sure you keep your API key and secret secure. The API connection requires TLS 1.2.
API Usage
URL Format, Data Format, and Pagination
AEFIS API calls require a basic authentication authorization header as part of the GET request. Data will be returned in JSON format.
The number of records returned from the API call will be limited by the API and unless a maxResults parameter is specified, the results returned in a single call might be incomplete. The client is responsible to use the start parameter to receive the rest of the data from the API.
Sample API Calls
Retrieve list of all colleges:
https://<aefis-url>/api/colleges
Optional Parameters:
| start | Starting position for the listing (can be used for paging) |
| maxResults | Integer (default to 50). Maximum number of results returned |
| sortOrder | Determines the order of results returned |
Retrieve the list of all departments:
https://<aefis-url>/api/departments
Optional Parameters:
| collegeId | Numeric Identifier (should be retrieved using the API) |
| start | Starting position for the listing (can be used for paging) |
| maxResults | Integer (default to 50). Maximum number of results returned |
| sortOrder | Determines the order of results returned |
Retrieve the list of courses:
https://<aefis-url>/api/courses
Optional Parameters:
| collegeId | Numeric Identifier (should be retrieved using the API) |
| departmentId | Numeric Identifier (should be retrieved using the API) |
| start | Starting position for the listing (can be used for paging) |
| maxResults | Integer (default to 50). Maximum number of results returned |
| sortOrder | Determines the order of results returned |
Retrieve the details of a single course:
https://<aefis-url>/api/v1/courses/
Required Parameters:
| courseId | Numeric Identifier (should be retrieved using the API) of the course |
Faculty Portfolio Details
AEFIS API Faulty Portfolio endpoints have been extended to provide additional details on the faculty portfolio information.
To receive ParentCategoryCode list:
<your institution url>/facultyPortfolio/parentCategoryCode/
You can use ‘all’ keyword to receive all activities for a faculty portfolio:
<your institution url>/facultyPortfolio/220/serviceActivity/all
You can separate use comma separated list to receive multiple categories:
<your institution url>/facultyPortfolio/220/serviceActivity/code1,code2
AEFIS API v.1.0 Endpoints
For a complete list of endpoints please go to <your institution url>/api.
