# Edtelligent API This API serves as a comprehensive and flexible interface for managing educational data, enabling seamless integration and efficient data exchange across courses, events, and related entities. It supports a wide range of functionalities, including managing course offerings, event scheduling, contact details, addresses, costs, and associated metadata like keywords and degrees. Version: 1.0.0 ## Servers Edtelligent Production API ``` https://api.edtelligent.de ``` ## Security ### Auth Type: http Scheme: bearer ## Download OpenAPI description [Edtelligent API](https://docs.edtelligent.de/_spec/openapi.yaml) ## Addresses The Addresses entity represents location and contact information for institutions or events. It includes fields for essential details such as street, country, and zip/city, along with communication options like phone, mobile, fax, email, and website URL. The entity also captures accessibility information (barrier_free), state references, and optional remarks for additional context. The institution field is mandatory, ensuring a clear association between the address and its organization. ### List Addresses - [GET /items/addresses](https://docs.edtelligent.de/openapi/addresses/readitemsaddresses.md): List the addresses items. ### Retrieve an Address - [GET /items/addresses/{id}](https://docs.edtelligent.de/openapi/addresses/readsingleitemsaddresses.md): Retrieve a single addresses item by unique identifier. ## Courses A course represents a detailed structure of educational offerings, encompassing various attributes about a course. It includes core information like title, description, institution, and type, as well as specifics like target groups, requirements, and funding options. Additional details such as costs, accessibility, and keywords provide comprehensive insights into the course's scope and reach. This entity is designed to capture all relevant data for managing, describing, and presenting educational courses effectively. The institution field is mandatory, ensuring a clear link to the course provider. ### List courses - [GET /items/courses](https://docs.edtelligent.de/openapi/courses/readitemscourses.md): List the courses items. ### Retrieve a course - [GET /items/courses/{id}](https://docs.edtelligent.de/openapi/courses/readsingleitemscourses.md): Retrieve a single courses item by unique identifier. ## Costs The Costs entity defines the financial details associated with a course. It includes properties such as the monetary value and the associated currency. ### List Costs - [GET /items/event_costs](https://docs.edtelligent.de/openapi/costs/readitemseventcosts.md): List the event_costs items. ### Retrieve a Cost Item - [GET /items/event_costs/{id}](https://docs.edtelligent.de/openapi/costs/readsingleitemseventcosts.md): Retrieve a single event_costs item by unique identifier. ## Course Degrees The Course Degrees entity represents information about degrees or certifications associated with a course. It includes attributes such as the degree title, additional qualifications, entitlements, and credits, offering a detailed view of the academic or professional value of the degree. ### List Course Degrees - [GET /items/course_degrees](https://docs.edtelligent.de/openapi/course-degrees/readitemscoursedegrees.md): List the course_degrees items. ### Retrieve a Course Degree - [GET /items/course_degrees/{id}](https://docs.edtelligent.de/openapi/course-degrees/readsingleitemscoursedegrees.md): Retrieve a single course_degrees item by unique identifier. ## Course Keywords The Course Keywords entity captures key terms or phrases associated with a course, facilitating better categorization and discoverability. ### List Course Keywords - [GET /items/course_keywords](https://docs.edtelligent.de/openapi/course-keywords/readitemscoursekeywords.md): List the course_keywords items. ### Retrieve a Course Keyword - [GET /items/course_keywords/{id}](https://docs.edtelligent.de/openapi/course-keywords/readsingleitemscoursekeywords.md): Retrieve a single course_keywords item by unique identifier. ## Contacts The Contacts entity provides detailed information about individuals or contact points associated with an institution. It includes personal attributes such as salutation, academic title, first and last name, and communication details like phone, mobile, fax, email, and website URL. Additional fields include role (linked to a predefined schema or integer) and labels for categorization, along with remarks for any specific notes. The institution field is mandatory, ensuring every contact is linked to a relevant organization. ### List Contacts - [GET /items/contacts](https://docs.edtelligent.de/openapi/contacts/readitemscontacts.md): List the contacts items. ### Retrieve a Contact - [GET /items/contacts/{id}](https://docs.edtelligent.de/openapi/contacts/readsingleitemscontacts.md): Retrieve a single contacts item by unique identifier. ## Events The Events entity represents detailed information about specific occurrences or sessions related to courses. It includes essential logistical details such as participant limits (min_participants and max_participants), event dates (event_start_date, event_end_date), and registration deadlines. Additional attributes cover the form and time of instruction, address, duration, and whether the event is in-house, part-time, or involves employer participation. Links to related courses, contacts, and execution forms ensure comprehensive integration with other entities. The institution field is mandatory, ensuring that every event is tied to its respective organization. ### List Events - [GET /items/events](https://docs.edtelligent.de/openapi/events/readitemsevents.md): List the events items. ### Retrieve an Event - [GET /items/events/{id}](https://docs.edtelligent.de/openapi/events/readsingleitemsevents.md): Retrieve a single events item by unique identifier. ## Certifiers All known certifiers. ### List Certifiers - [GET /items/certifiers](https://docs.edtelligent.de/openapi/certifiers/readitemscertifiers.md): List the certifiers items. ### Retrieve a Certifier - [GET /items/certifiers/{id}](https://docs.edtelligent.de/openapi/certifiers/readsingleitemscertifiers.md): Retrieve a single certifiers item by unique identifier. ## Course Types Type of the course. ### List Course Types - [GET /items/course_types](https://docs.edtelligent.de/openapi/course-types/readitemscoursetypes.md): List the course_types items. ### Retrieve a Course Type - [GET /items/course_types/{id}](https://docs.edtelligent.de/openapi/course-types/readsingleitemscoursetypes.md): Retrieve a single course_types item by unique identifier. ## Durations All durations. ### List Durations - [GET /items/durations](https://docs.edtelligent.de/openapi/durations/readitemsdurations.md): List the durations items. ### Retrieve a Duration - [GET /items/durations/{id}](https://docs.edtelligent.de/openapi/durations/readsingleitemsdurations.md): Retrieve a single durations item by unique identifier. ## Education Types All education types from Kursnet. ### List Education Types - [GET /items/education_types](https://docs.edtelligent.de/openapi/education-types/readitemseducationtypes.md): List the education_types items. ### Retrieve an Education Type - [GET /items/education_types/{id}](https://docs.edtelligent.de/openapi/education-types/readsingleitemseducationtypes.md): Retrieve a single education_types item by unique identifier. ## Funding Types Federals All federal funding types. ### List Funding Types Federals - [GET /items/funding_types_federals](https://docs.edtelligent.de/openapi/funding-types-federals/readitemsfundingtypesfederals.md): List the funding_types_federals items. ### Retrieve a Fundings Types Federal - [GET /items/funding_types_federals/{id}](https://docs.edtelligent.de/openapi/funding-types-federals/readsingleitemsfundingtypesfederals.md): Retrieve a single funding_types_federals item by unique identifier. ## Funding Types Regions All regional funding types. ### List Funding Types Regions - [GET /items/funding_types_regions](https://docs.edtelligent.de/openapi/funding-types-regions/readitemsfundingtypesregions.md): List the funding_types_regions items. ### Retrieve a Funding Types Region - [GET /items/funding_types_regions/{id}](https://docs.edtelligent.de/openapi/funding-types-regions/readsingleitemsfundingtypesregions.md): Retrieve a single funding_types_regions item by unique identifier. ## Handicaps Courses are suitable for these handicaps. ### List Handicaps - [GET /items/handicaps](https://docs.edtelligent.de/openapi/handicaps/readitemshandicaps.md): List the handicaps items. ### Retrieve a Handicap - [GET /items/handicaps/{id}](https://docs.edtelligent.de/openapi/handicaps/readsingleitemshandicaps.md): Retrieve a single handicaps item by unique identifier. ## Institution Types Type of the institution. ### List Institution Types - [GET /items/institution_types](https://docs.edtelligent.de/openapi/institution-types/readitemsinstitutiontypes.md): List the institution_types items. ### Retrieve an Institution Type - [GET /items/institution_types/{id}](https://docs.edtelligent.de/openapi/institution-types/readsingleitemsinstitutiontypes.md): Retrieve a single institution_types item by unique identifier. ## Instruction Forms All instruction forms. ### List Instruction Forms - [GET /items/instruction_forms](https://docs.edtelligent.de/openapi/instruction-forms/readitemsinstructionforms.md): List the instruction_forms items. ### Retrieve an Instruction Form - [GET /items/instruction_forms/{id}](https://docs.edtelligent.de/openapi/instruction-forms/readsingleitemsinstructionforms.md): Retrieve a single instruction_forms item by unique identifier. ## Instruction Times All instruction times. ### List Instruction Time - [GET /items/instruction_times](https://docs.edtelligent.de/openapi/instruction-times/readitemsinstructiontimes.md): List the instruction_times items. ### Retrieve an Instruction Time - [GET /items/instruction_times/{id}](https://docs.edtelligent.de/openapi/instruction-times/readsingleitemsinstructiontimes.md): Retrieve a single instruction_times item by unique identifier. ## Locations Mapping of zip code and city names ### List Locations - [GET /items/locations](https://docs.edtelligent.de/openapi/locations/readitemslocations.md): List the locations items. ### Retrieve a Location - [GET /items/locations/{id}](https://docs.edtelligent.de/openapi/locations/readsingleitemslocations.md): Retrieve a single locations item by unique identifier. ## States All German states. ### List States - [GET /items/states](https://docs.edtelligent.de/openapi/states/readitemsstates.md): List the states items. ### Retrieve a State - [GET /items/states/{id}](https://docs.edtelligent.de/openapi/states/readsingleitemsstates.md): Retrieve a single states item by unique identifier. ## Systematics All systematics from Kursnet. ### List Systematics - [GET /items/systematics](https://docs.edtelligent.de/openapi/systematics/readitemssystematics.md): List the systematics items. ### Retrieve a Systematic - [GET /items/systematics/{id}](https://docs.edtelligent.de/openapi/systematics/readsingleitemssystematics.md): Retrieve a single systematics item by unique identifier.