Skip to main content

Which data do you need?

The first step is to think about which data you need, and how it maps onto Eduframe. The image below shows the structure of Eduframe.

  • PlannedCourse: Type Within Eduframe we have two types of planned course: fixed and flexible. Fixed planned courses have a starting date. Flexible planned courses are often online courses; they don’t have a starting date but start immediately after you enroll.

  • PlannedCourse | Edition: max_participants, current_participants You can use these properties to do stock management. When current_participants >= max_participants, the course is full and customers can no longer enroll. You can also use these numbers to show how many places are still available. Be careful: max_participants is optional and doesn’t have to be provided.

  • PlannedCourse | Edition: signup_url This is the URL of the Eduframe signup page. If you want to use this signup, you should redirect the customer to this URL after they click enroll.

  • Category | Course | Program: position This property indicates how the admin ordered them in the admin panel. Often we use the same ordering when showing an overview.

  • Category | Course | Program: avatar This is the link to the image set by the admin. We recommend that you download or copy the image to your own CMS to make sure it's always available. That also lets you create optimized images for the website.

  • Course | Program: custom These are custom properties that can be defined by the admin in Eduframe for these object types. These are returned by the API as a JSON object: { "key": "value", "key2": "value" }.

  • PlannedCourse | Edition: custom The same as above, but these are different fields.

  • Category | Course | PlannedCourse | Program | Edition: published In the admin panel of Eduframe, the customer can indicate whether a course should be published. A planned course is only published (and available for signup) if the planned course, the linked course, and the linked category are published. The same holds for Edition, Program, and Category.