Configuring Course Sync
💡 Our team is able to map data found in your course feed to Prospectus Plus. This data can then be output on your course pages or used to organise them within the CMS.
To ensure a seamless course sync process with Prospectus Plus, your technical team needs to prepare and provide a data feed. This guide outlines the essential steps and requirements to help you achieve a smooth integration.
Your data feed should be hosted online in a publicly accessible location, ensuring it’s available for Prospectus Plus to sync. The recommended format for this feed is either JSON or XML. If your feed contains sensitive data, we strongly recommend removing it prior to sharing.
We accept both hosted files and API endpoints for the data feed. Regardless of your choice, ensure the feed remains accessible for future syncs.
The current sync process supports mapping to the following Prospectus Plus fields, all of which can be included in your data feed:
- ea_course_id: The unique identifier for each course. This field is required.
- ea_course_code: The code assigned to the course.
- ea_course_title: The title or name of the course.
- ea_subject_area: The subject area or category of the course.
- ea_award: The type of award or qualification associated with the course.
- ea_school: The school or department offering the course.
- ea_mode: The mode of study (e.g., full-time, part-time, online).
- ea_campus: The campus or location where the course is offered.
- ea_institution: The institution providing the course.
- ea_hero_image: The URL or path to the hero image representing the course.
- ea_hero_video: The URL or path to the hero video representing the course.
- ea_external_url: The URL to an external website providing more information about the course.
- ea_ucas_code: The UCAS code assigned to the course (if applicable).
- ea_discover_uni: Information about the course available on Discover Uni (if applicable).
- ea_overview: A brief overview or summary of the course.
- ea_course_description: Detailed description of the course.
- ea_fees_and_funding: Information about fees and funding options for the course.
- ea_entry_requirement: Entry requirements for the course.
- ea_industry_placement: Information about industry placement opportunities.
- ea_modules: List of modules or units included in the course.
- ea_level: The academic level or stage of the course.
- ea_learning: Information about the learning experience and teaching methods.
- ea_assessment: Details about the assessment methods used in the course.
- ea_program_specification: The program specification document for the course.
- ea_institution_school_description: Description of the institution or school offering the course.
- ea_facilities: Information about facilities and resources available for the course.
- ea_student_profiles: Profiles of current or past students of the course.
- ea_open_days: Dates and details of upcoming open days or campus visits.
- ea_contact: Contact information for inquiries about the course.
- ea_careers: Information about career opportunities associated with the course.
- ea_subject_requirements: Subject-specific requirements or prerequisites.
- ea_teaching_and_assessment: Detailed information about teaching and assessment methods.
- ea_keywords: Relevant keywords or tags associated with the course.
Even if certain fields are not intended for display on the course page, you may still include them to support the internal organisation of courses.
Once your feed is ready, please provide us with the feed URL. Additionally, specify which fields from the above list should be used as part of your default course template. Your developer can indicate which fields are necessary to tailor course information to individual users.
If any pre-processing of the data is required (e.g., appending fields or modifying values), ensure that you clearly outline these instructions for your technical team. This might include additional fields or specific data transformations to be applied before the sync process.
By adhering to the guidelines outlined in this documentation, your technical team will ensure a successful sync process with Prospectus Plus.
If you have any further questions or require additional assistance, please don’t hesitate to reach out to our team.
To ensure a seamless course sync process with Prospectus Plus, your technical team needs to prepare and provide a data feed. This guide outlines the essential steps and requirements to help you achieve a smooth integration.
Data Feed Setup
Your data feed should be hosted online in a publicly accessible location, ensuring it’s available for Prospectus Plus to sync. The recommended format for this feed is either JSON or XML. If your feed contains sensitive data, we strongly recommend removing it prior to sharing.
We accept both hosted files and API endpoints for the data feed. Regardless of your choice, ensure the feed remains accessible for future syncs.
Sync Fields
The current sync process supports mapping to the following Prospectus Plus fields, all of which can be included in your data feed:
- ea_course_id: The unique identifier for each course. This field is required.
- ea_course_code: The code assigned to the course.
- ea_course_title: The title or name of the course.
- ea_subject_area: The subject area or category of the course.
- ea_award: The type of award or qualification associated with the course.
- ea_school: The school or department offering the course.
- ea_mode: The mode of study (e.g., full-time, part-time, online).
- ea_campus: The campus or location where the course is offered.
- ea_institution: The institution providing the course.
- ea_hero_image: The URL or path to the hero image representing the course.
- ea_hero_video: The URL or path to the hero video representing the course.
- ea_external_url: The URL to an external website providing more information about the course.
- ea_ucas_code: The UCAS code assigned to the course (if applicable).
- ea_discover_uni: Information about the course available on Discover Uni (if applicable).
- ea_overview: A brief overview or summary of the course.
- ea_course_description: Detailed description of the course.
- ea_fees_and_funding: Information about fees and funding options for the course.
- ea_entry_requirement: Entry requirements for the course.
- ea_industry_placement: Information about industry placement opportunities.
- ea_modules: List of modules or units included in the course.
- ea_level: The academic level or stage of the course.
- ea_learning: Information about the learning experience and teaching methods.
- ea_assessment: Details about the assessment methods used in the course.
- ea_program_specification: The program specification document for the course.
- ea_institution_school_description: Description of the institution or school offering the course.
- ea_facilities: Information about facilities and resources available for the course.
- ea_student_profiles: Profiles of current or past students of the course.
- ea_open_days: Dates and details of upcoming open days or campus visits.
- ea_contact: Contact information for inquiries about the course.
- ea_careers: Information about career opportunities associated with the course.
- ea_subject_requirements: Subject-specific requirements or prerequisites.
- ea_teaching_and_assessment: Detailed information about teaching and assessment methods.
- ea_keywords: Relevant keywords or tags associated with the course.
Even if certain fields are not intended for display on the course page, you may still include them to support the internal organisation of courses.
Preparing Your Feed URL
Once your feed is ready, please provide us with the feed URL. Additionally, specify which fields from the above list should be used as part of your default course template. Your developer can indicate which fields are necessary to tailor course information to individual users.
Pre-Processing and Customisation
If any pre-processing of the data is required (e.g., appending fields or modifying values), ensure that you clearly outline these instructions for your technical team. This might include additional fields or specific data transformations to be applied before the sync process.
By adhering to the guidelines outlined in this documentation, your technical team will ensure a successful sync process with Prospectus Plus.
Need Support?
If you have any further questions or require additional assistance, please don’t hesitate to reach out to our team.
Updated on: 17/10/2024
Thank you!