Skip to content
API Documentation
/
Institution Types
/
List Institution Types

Edtelligent API (1.0.0)

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.

Languages
Servers
Edtelligent Production API

https://api.edtelligent.de/

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.

Operations

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.

Operations

Costs

The Costs entity defines the financial details associated with a course. It includes properties such as the monetary value and the associated currency.

Operations

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.

Operations

Course Keywords

The Course Keywords entity captures key terms or phrases associated with a course, facilitating better categorization and discoverability.

Operations

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.

Operations

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.

Operations

Certifiers

All known certifiers.

Operations

Course Types

Type of the course.

Operations

Durations

All durations.

Operations

Education Types

All education types from Kursnet.

Operations

Funding Types Federals

All federal funding types.

Operations

Funding Types Regions

All regional funding types.

Operations

Handicaps

Courses are suitable for these handicaps.

Operations

Institution Types

Type of the institution.

Operations

List Institution Types

Request

List the institution_types items.

Security
Auth
Query
fieldsArray of strings

Control what fields are being returned in the object.

limitinteger

A limit on the number of objects that are returned.

pageinteger

Cursor for use in pagination. Often used in combination with limit.

metastring

What metadata to return in the response.

Enum"total_count""filter_count""*"
offsetinteger

How many items to skip when fetching data.

sortArray of strings

How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.

filterobject

Select items in collection by given conditions.

searchstring

Filter by items that contain the given search query in one of their fields.

curl -i -X GET \
  'https://api.edtelligent.de/items/institution_types?fields=string&limit=0&page=0&meta=total_count&offset=0&sort=string&filter={%22%3Cfield%3E%22%3A{%22%3Coperator%3E%22%3A%22_eq%22%2C%22property1%22%3A%22string%22%2C%22property2%22%3A%22string%22}}&search=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful request

Bodyapplication/json
dataArray of objects(InstitutionTypes)
metaobject(x-metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "total_count": 100,
    "filter_count": 10
  }
}

Retrieve an Institution Type

Request

Retrieve a single institution_types item by unique identifier.

Security
Auth
Path
idintegerrequired

Index of the item.

Example: 1
Query
fieldsArray of strings

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Enum"total_count""filter_count""*"
curl -i -X GET \
  'https://api.edtelligent.de/items/institution_types/1?fields=string&meta=total_count' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful request

Bodyapplication/json
dataobject(InstitutionTypes)
Response
application/json
{
  "data": {
    "id": 1,
    "kursnet_id": 105,
    "name": "Einrichtung der beruflichen Weiterbildung"
  }
}

Instruction Forms

All instruction forms.

Operations

Instruction Times

All instruction times.

Operations

Locations

Mapping of zip code and city names

Operations

States

All German states.

Operations

Systematics

All systematics from Kursnet.

Operations