Download OpenAPI specification:Download
Datenaustausch mit HiOrg-Server im Format JSON:API Download Repository für Talend API Tester
List of all Courses
filter[from] | string <date> Only courses with course date after the given date. Date in format 'Y-m-d'. Default: today midnight |
filter[until] | string <date> Only courses with course date befor the given date. Date in format 'Y-m-d'. Default: today midnight in 12 month |
filter[trainer_user_id] | string Only courses with the given user id assigned as trainer Default: null |
include | string Linked objects to be supplied (as comma-separated list). Possible values are e.g.: 'client'. dates and location are default included |
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "course",
- "id": "1234",
- "attributes": {
- "title": "Erste-Hilfe",
- "course_number": "EH-2022-17",
- "uvt_registration_number": "12/2024",
- "status": "ready",
- "comment": "",
- "number_of_participants": 20,
- "max_participants": 20
}, - "relationships": {
- "course_type": {
- "data": {
- "type": "course_type",
- "id": "1234"
}
}, - "dates": {
- "data": [
- {
- "type": "course_date",
- "id": "1234"
}
]
}, - "location": {
- "data": {
- "type": "address",
- "id": "1234"
}
}
}
}
], - "included": [
- {
- "type": "course_type",
- "id": "1234",
- "attributes": {
- "name": "Erste-Hilfe",
- "short_name": "EH"
}
}, - {
- "type": "course_date",
- "id": "1234",
- "attributes": {
- "from": "2022-10-01T08:00:00+02:00",
- "to": "2022-10-01T16:00:00+02:00"
}
}, - {
- "type": "address",
- "id": "1234",
- "attributes": {
- "description": "codea headquarter",
- "street": "Ensheimer Straße 12",
- "address_addition": "c/o Ms. Doe",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "contact_person_salutation": "Herr",
- "contact_person_name": "John Doe",
- "phone": "06894-895444",
- "mobile": "0163-7594485",
- "fax": "06894-895445",
- "email": "mail@codea.de",
- "reference": "4711",
- "geo": {
- "latitude": "50.2128736",
- "longitude": "8.27180175"
}
}
}
]
}
Creates a new course for a given course type.
ATTENTION: Course will NOT be sent to external systems like DLDB.
required | object (course_post_request) courseinformation |
{- "data": {
- "type": "course",
- "id": "1234",
- "attributes": {
- "title": "codea headquarter",
- "course_number": "Ensheimer Straße 12",
- "status": "ready",
- "comment": "Test",
- "max_participants": 15
}, - "relationships": {
- "client": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "course_type": {
- "data": {
- "type": "course_type",
- "id": "1234"
}
}, - "course_dates": {
- "data": {
- "type": "course_date",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}
}
}
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "course",
- "id": "1234",
- "attributes": {
- "title": "codea headquarter",
- "course_number": "Ensheimer Straße 12",
- "status": "ready",
- "comment": "Test",
- "max_participants": 15
}, - "relationships": {
- "client": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "course_type": {
- "data": {
- "type": "course_type",
- "id": "1234"
}
}, - "course_dates": {
- "data": {
- "type": "course_date",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "course_type",
- "id": "1234",
- "attributes": {
- "name": "Erste-Hilfe",
- "short_name": "EH"
}
}, - {
- "type": "course_date",
- "id": "1234",
- "attributes": {
- "from": "2022-10-01T08:00:00+02:00",
- "to": "2022-10-01T16:00:00+02:00"
}
}, - {
- "type": "address",
- "id": "1234",
- "attributes": {
- "description": "codea headquarter",
- "street": "Ensheimer Straße 12",
- "address_addition": "c/o Ms. Doe",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "contact_person_salutation": "Herr",
- "contact_person_name": "John Doe",
- "phone": "06894-895444",
- "mobile": "0163-7594485",
- "fax": "06894-895445",
- "email": "mail@codea.de",
- "reference": "4711",
- "geo": {
- "latitude": "50.2128736",
- "longitude": "8.27180175"
}
}
}
]
}
gets information about the course entry with the ID {id}
id required | integer ID of the course entry |
include | string Linked objects to be supplied (as comma-separated list). Possible values are e.g.: 'client', course_type. dates and location are default included |
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "course",
- "id": "1234",
- "attributes": {
- "title": "Erste-Hilfe",
- "course_number": "EH-2022-17",
- "uvt_registration_number": "12/2024",
- "status": "ready",
- "comment": "",
- "number_of_participants": 20,
- "max_participants": 20
}, - "relationships": {
- "course_type": {
- "data": {
- "type": "course_type",
- "id": "1234"
}
}, - "dates": {
- "data": [
- {
- "type": "course_date",
- "id": "1234"
}
]
}, - "location": {
- "data": {
- "type": "address",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "course_type",
- "id": "1234",
- "attributes": {
- "name": "Erste-Hilfe",
- "short_name": "EH"
}
}, - {
- "type": "course_date",
- "id": "1234",
- "attributes": {
- "from": "2022-10-01T08:00:00+02:00",
- "to": "2022-10-01T16:00:00+02:00"
}
}, - {
- "type": "address",
- "id": "1234",
- "attributes": {
- "description": "codea headquarter",
- "street": "Ensheimer Straße 12",
- "address_addition": "c/o Ms. Doe",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "contact_person_salutation": "Herr",
- "contact_person_name": "John Doe",
- "phone": "06894-895444",
- "mobile": "0163-7594485",
- "fax": "06894-895445",
- "email": "mail@codea.de",
- "reference": "4711",
- "geo": {
- "latitude": "50.2128736",
- "longitude": "8.27180175"
}
}
}
]
}
gets information about participations in one course with ID {id}
course_id required | integer ID of the course entry |
include | string Linked objects to be supplied (as comma-separated list). Possible values are e.g.: 'company, uvt'. |
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "participation",
- "id": "1234",
- "attributes": {
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "not_invoiced": false,
- "participation_fee_in_cents": 4230,
- "paid": true,
- "paid_at": "2024-01-01",
- "payment_method": "paypal"
}, - "relationships": {
- "course": {
- "data": {
- "type": "course",
- "id": "1234"
}
}, - "participant": {
- "data": {
- "type": "participant",
- "id": "1234"
}
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "uvt": {
- "data": {
- "type": "uvt",
- "id": "1234"
}
}
}
}
], - "included": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}, - {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}
registers a participant for a specific course with ID {id}
course_id required | integer ID of the course entry |
required | object (participation_post) Participationdata |
Array of items |
{- "data": {
- "type": "participation",
- "id": "1234",
- "attributes": {
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "not_invoiced": false,
- "participation_fee_in_cents": 4230,
- "paid": true,
- "payment_method": "paypal"
}, - "relationships": {
- "course": {
- "data": {
- "type": "course",
- "id": "1234"
}
}, - "participant": {
- "data": {
- "type": "participant",
- "id": "1234"
}
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "uvt": {
- "data": {
- "type": "uvt",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}, - {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "participation",
- "id": "1234",
- "attributes": {
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "not_invoiced": false,
- "participation_fee_in_cents": 4230,
- "paid": true,
- "paid_at": "2024-01-01",
- "payment_method": "paypal"
}, - "relationships": {
- "course": {
- "data": {
- "type": "course",
- "id": "1234"
}
}, - "participant": {
- "data": {
- "type": "participant",
- "id": "1234"
}
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "uvt": {
- "data": {
- "type": "uvt",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}, - {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}
gets information about one participation in one course with ID {id}
course_id required | integer ID of the course entry |
id required | integer ID of the participation |
include | string Linked objects to be supplied (as comma-separated list). Possible values are e.g.: 'company, uvt'. |
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "participation",
- "id": "1234",
- "attributes": {
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "not_invoiced": false,
- "participation_fee_in_cents": 4230,
- "paid": true,
- "paid_at": "2024-01-01",
- "payment_method": "paypal"
}, - "relationships": {
- "course": {
- "data": {
- "type": "course",
- "id": "1234"
}
}, - "participant": {
- "data": {
- "type": "participant",
- "id": "1234"
}
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "uvt": {
- "data": {
- "type": "uvt",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}, - {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}
change a participant for a specific course with ID {id}
only the attributes that are to be changed must be transferred",
course_id required | integer ID of the course entry |
id required | integer ID of the participation |
required | object (participation_patch) Participationdata |
Array of items |
{- "data": {
- "type": "participation",
- "id": "1234",
- "attributes": {
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "not_invoiced": false,
- "participation_fee_in_cents": 4230,
- "paid": true,
- "payment_method": "paypal"
}, - "relationships": {
- "course": {
- "data": {
- "type": "course",
- "id": "1234"
}
}, - "participant": {
- "data": {
- "type": "participant",
- "id": "1234"
}
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "uvt": {
- "data": {
- "type": "uvt",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}, - {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "participation",
- "id": "1234",
- "attributes": {
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "not_invoiced": false,
- "participation_fee_in_cents": 4230,
- "paid": true,
- "paid_at": "2024-01-01",
- "payment_method": "paypal"
}, - "relationships": {
- "course": {
- "data": {
- "type": "course",
- "id": "1234"
}
}, - "participant": {
- "data": {
- "type": "participant",
- "id": "1234"
}
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}, - "uvt": {
- "data": {
- "type": "uvt",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}, - {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}
Deregisters a specific user with an ID from a course
course_id required | integer ID of the course entry |
id required | integer ID of the participation |
required | object (cancellation_post_request) Cancellationdata |
{- "data": {
- "type": "cancellation",
- "id": "1234",
- "attributes": {
- "reason": "double termination"
}
}
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "cancellation",
- "id": "1234",
- "attributes": {
- "reason": "double termination",
- "cancelled_by": "external",
- "cancelled_at": "2022-10-01T16:00:00+02:00"
}
}
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}
]
}
List one specific client
id required | integer ID of the client |
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "client",
- "id": "1234",
- "attributes": {
- "name": "codea IT-Services GmbH",
- "client_number": "17"
}, - "relationships": {
- "contact_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "course_locations": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "invoice_addresses": {
- "data": {
- "type": "address",
- "id": "1234"
}
}, - "client_uvts": {
- "data": {
- "type": "client_uvt",
- "id": "123"
}
}
}
}
}
Lists all courses where a certain customer has participants or he is the client,
based on his ID {id}.
If no location is known, the location object is omitted.
If no geo information is available, the geo attribute is omitted.
id required | integer ID of the client |
include | string Linked objects to be supplied (as comma-separated list). Possible values are e.g.: 'course_type, course_date, address'. |
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "course",
- "id": "1234",
- "attributes": {
- "title": "Erste-Hilfe",
- "course_number": "EH-2022-17",
- "uvt_registration_number": "12/2024",
- "status": "ready",
- "comment": "",
- "number_of_participants": 20,
- "max_participants": 20
}, - "relationships": {
- "course_type": {
- "data": {
- "type": "course_type",
- "id": "1234"
}
}, - "dates": {
- "data": [
- {
- "type": "course_date",
- "id": "1234"
}
]
}, - "location": {
- "data": {
- "type": "address",
- "id": "1234"
}
}
}
}
], - "included": [
- {
- "type": "course_type",
- "id": "1234",
- "attributes": {
- "name": "Erste-Hilfe",
- "short_name": "EH"
}
}, - {
- "type": "course_date",
- "id": "1234",
- "attributes": {
- "from": "2022-10-01T08:00:00+02:00",
- "to": "2022-10-01T16:00:00+02:00"
}
}, - {
- "type": "address",
- "id": "1234",
- "attributes": {
- "description": "codea headquarter",
- "street": "Ensheimer Straße 12",
- "address_addition": "c/o Ms. Doe",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "contact_person_salutation": "Herr",
- "contact_person_name": "John Doe",
- "phone": "06894-895444",
- "mobile": "0163-7594485",
- "fax": "06894-895445",
- "email": "mail@codea.de",
- "reference": "4711",
- "geo": {
- "latitude": "50.2128736",
- "longitude": "8.27180175"
}
}
}
]
}
gets information about the course entry with the ID {id}
id required | integer ID of the course entry |
include | string Linked objects to be supplied (as comma-separated list). Possible values are e.g.: 'client', course_type. dates and location are default included |
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "course",
- "id": "1234",
- "attributes": {
- "title": "Erste-Hilfe",
- "course_number": "EH-2022-17",
- "uvt_registration_number": "12/2024",
- "status": "ready",
- "comment": "",
- "number_of_participants": 20,
- "max_participants": 20
}, - "relationships": {
- "course_type": {
- "data": {
- "type": "course_type",
- "id": "1234"
}
}, - "dates": {
- "data": [
- {
- "type": "course_date",
- "id": "1234"
}
]
}, - "location": {
- "data": {
- "type": "address",
- "id": "1234"
}
}
}
}, - "included": [
- {
- "type": "course_type",
- "id": "1234",
- "attributes": {
- "name": "Erste-Hilfe",
- "short_name": "EH"
}
}, - {
- "type": "course_date",
- "id": "1234",
- "attributes": {
- "from": "2022-10-01T08:00:00+02:00",
- "to": "2022-10-01T16:00:00+02:00"
}
}, - {
- "type": "address",
- "id": "1234",
- "attributes": {
- "description": "codea headquarter",
- "street": "Ensheimer Straße 12",
- "address_addition": "c/o Ms. Doe",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "contact_person_salutation": "Herr",
- "contact_person_name": "John Doe",
- "phone": "06894-895444",
- "mobile": "0163-7594485",
- "fax": "06894-895445",
- "email": "mail@codea.de",
- "reference": "4711",
- "geo": {
- "latitude": "50.2128736",
- "longitude": "8.27180175"
}
}
}
]
}
List all participants of a specific client
id required | integer ID of the client |
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "participant",
- "id": "1234",
- "attributes": {
- "date": "2022-09-12",
- "status": "active",
- "salutation": "Herr",
- "name": "Doe",
- "first_name": "John",
- "birthdate": "1978-07-28",
- "street": "Ensheimer Straße 12",
- "postal_code": "66386",
- "city": "St. Ingbert",
- "country": "Deutschland",
- "email": "john@doe.de",
- "comment": "Notes for John Doe"
}, - "relationships": {
- "participations": {
- "data": [
- {
- "type": "participation",
- "id": "1234"
}
]
}, - "company": {
- "data": {
- "type": "client",
- "id": "1234"
}
}
}
}
]
}
List of all custom fields
courseId required | integer Course ID |
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "customfield",
- "id": "1234",
- "attributes": {
- "name": "essen_inklusive",
- "value": "false",
- "field_type": "checkbox"
}
}
]
}
Adds a new custom field to a course
courseId required | integer Course ID |
required | object (customfield_post_request) Custom field |
{- "data": {
- "type": "customfield",
- "id": "1234",
- "attributes": {
- "name": "essen_inklusive",
- "value": "false",
- "field_type": "checkbox"
}
}
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "customfield",
- "id": "1234",
- "attributes": {
- "name": "essen_inklusive",
- "value": "false",
- "field_type": "checkbox"
}
}
}
List one specific custom field
courseId required | integer Course ID |
id required | integer Custom field ID |
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "customfield",
- "id": "1234",
- "attributes": {
- "name": "essen_inklusive",
- "value": "false",
- "field_type": "checkbox"
}
}
}
change a custom field of specific course with ID {id}
only the attributes that are to be changed must be transferred
courseId required | integer Course ID |
id required | integer Custom field ID |
required | object (customfield_patch_request) Custom field |
{- "data": {
- "type": "customfield",
- "id": "1234",
- "attributes": {
- "name": "essen_inklusive",
- "value": "false",
- "field_type": "checkbox"
}
}
}
{- "jsonapi": {
- "version": "1.0"
}, - "data": {
- "type": "customfield",
- "id": "1234",
- "attributes": {
- "name": "essen_inklusive",
- "value": "false",
- "field_type": "checkbox"
}
}
}
Deletes a custom field with ID {id} in course with courseID {courseID}
DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.
courseId required | integer Course ID |
id required | integer Custom field ID |
{- "errors": [
- {
- "status": 403,
- "code": "permission_denied",
- "title": "Zugriff nicht erlaubt",
- "detail": "Admin-Rechte im Account erforderlich zur Abfrage dieser Daten"
}
]
}
If the 'Select favorites' setting is activated, only the UVTs marked as favorites are output.
{- "jsonapi": {
- "version": "1.0"
}, - "data": [
- {
- "type": "uvt",
- "id": "1234",
- "attributes": {
- "name": "BG Verkehr",
- "name_addition": "Hauptverwaltung",
- "comment": "Bitte vorher die Kostenübernahme beantragen!"
}
}
]
}