API Documentation - Dynamics Edge

Constructing API Request URLs

DynamicsEdge API request URLs are composed of the following components:

Term Definition
protocol https only
data-type Only json is supported as a data-type.
hostname Our API services are available on our www.dynamicsedge.com domain.
API Methods See below for documentation on section and courses methods.
request parameters Key/Value pairs of request data, as defined in the courses documentation.

Put all these pieces together, and you should end up with a URL that looks something like this:

API Methods


Sections

This endpoint allows you to retrieve sections from the DynamicsEdge database.

Return Fields

Name Definition
value Use this internal value to select/filter courses.
displayValue This is for displaying to the end user.
courseCount The number of courses available under this section.

Courses

This endpoint allows you to retrieve courses from the DynamicsEdge database.

Input Parameters

Name Definition
section Use section value (not displayValue) returned from the section method to filter course selection.
page_size An integer, for example 25, that limits the number of courses retrieved per request.
page Used to navigate through the available pages.

Return Fields

Name Definition
pagination A group of fields used to fetch and navigate pages of courses.
course_count Number of courses returned in the course query.
page The current loaded page.
page_size The number of courses per page.
page_count The number of total pages.
courses A group containing the list of courses.
name The name of the course.
section The section the current course is grouped under.
route A unique string identifying the course.
url The link to the course.
popular A value of 1 indicates a popular course.
length The course length, measured in days.
price Base price of the current course.
description A detailed course description, formatted in html.
scheduled_dates Lists all dates and locations for the current course. Will have a value of null, if none available.

Code Example

Here’s a jQuery ajax call using jsonp to fetch courses from the API.

		
			
$.ajax({
   type: "GET",
   url: "https://www.dynamicsedge.com/api/courses",
   data: {section: "office-365", page_size: 10},
   dataType: "jsonp",
   success: function (responseData) {
       console.log(responseData);
       //do something
   }
});