Zenler (Unabhängiger Herausgeber) (Vorschau)
Zenler ist eine All-in-One-Kurserstellungs-, Liefer- und Marketingplattform.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Troy Taylor |
| Webseite | https://www.newzenler.com/ |
| Datenschutzrichtlinie | https://www.newzenler.com/privacy-policy |
| Kategorien | Unternehmensverwaltung |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | securestring | Der API-Schlüssel für diese API | Richtig |
| Kontoname | securestring | Der Kontoname für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abbestellen des Trichters |
Gekündigt einen Benutzer von einem Trichter. |
| Abonnieren des Trichters |
Abonnieren sie einen Benutzer zu einem Trichter. |
| Abrufen eines kurzen Kursfortschrittsberichts |
Ruft einen kurzen Bericht des Kursfortschritts ab. |
| Abrufen eines kurzen Partnerberichts |
Ruft einen kurzen Bericht von Verbundenen ab. |
| Abrufen eines kurzen Registrierungsberichts |
Ruft eine kurze Liste der Registrierungen ab. |
| Abrufen eines kurzen Verkaufsberichts |
Ruft einen kurzen Bericht über verkäufe ab. |
| Abrufen von Benutzerdetails |
Abrufen von Informationen zu einem Benutzer. |
| Abrufen von Registrierungen für einen Trichter |
Ruft eine Liste der Registrierungen für einen Trichter ab. |
| Abrufen von Trichtern |
Ruft eine Liste von Trichtern ab. |
| Anstehende Kurse erhalten |
Ruft eine Liste der anstehenden Live-Kurse ab. |
| Anstehende Webinare erhalten |
Dient zum Abrufen einer Liste anstehender Live-Webinare. |
| Aufheben der Registrierung eines Benutzers |
Hebt die Registrierung eines Benutzers aus einem Kurs auf. |
| Aufheben der Registrierung für den Kurs |
Heben Sie die Registrierung eines Benutzers für eine Liveklasse auf. |
| Benutzer aktualisieren |
Aktualisiert die Informationen eines Benutzers. |
| Benutzer hinzufügen |
Erstellt einen neuen Benutzer. |
| Benutzerliste abrufen |
Ruft eine Liste der Benutzer ab. |
| Detaillierter Kursfortschrittsbericht abrufen |
Ruft einen detaillierten Bericht des Kursfortschritts ab. |
| Detaillierter Partnerbericht abrufen |
Ruft einen detaillierten Bericht von Verbundenen ab. |
| Detaillierter Registrierungsbericht abrufen |
Ruft eine detaillierte Liste der Registrierungen ab. |
| Detaillierter Umsatzbericht abrufen |
Ruft einen detaillierten Umsatzbericht ab. |
| Für den Kurs registrieren |
Registrieren sie einen Benutzer für eine Live-Klasse. |
| Kurs abrufen |
Ruft einen Kurs nach Kursbezeichner ab. |
| Liste der Kurse abrufen |
Ruft eine Liste von Kursen ab. |
| Löschen eines Benutzers |
Entfernen Sie einen Benutzer aus Ihrem Konto. |
| Registrieren eines Benutzers |
Registriert einen Benutzer für einen Kurs. |
| Registrieren für Webinar |
Registrieren Sie einen Benutzer für ein Live-Webinar. |
| Registrierung für Webinar aufheben |
Heben Sie die Registrierung eines Benutzers für ein Live-Webinar auf. |
Abbestellen des Trichters
Gekündigt einen Benutzer von einem Trichter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Trichter-ID
|
funnel_id | True | string |
Der Trichterbezeichner. |
|
Email
|
string |
Die E-Mail. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Daten
|
data | string |
Die Daten. |
Abonnieren des Trichters
Abonnieren sie einen Benutzer zu einem Trichter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Trichter-ID
|
funnel_id | True | string |
Der Trichterbezeichner. |
|
Name
|
name | True | string |
Der Name. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Nachname
|
last_name | string |
Der Nachname. |
|
|
Adresse
|
address | string |
Die Adresse. |
|
|
Stadt
|
city | string |
Die Stadt. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Telefonnummer
|
phone | string |
Die Telefonnummer. |
|
|
PLZ
|
zip_code | integer |
Die Postleitzahl. |
|
|
Country
|
country | string |
Das Land. |
|
|
DSGVO-Zustimmungsstatus
|
gdpr_consent_status | integer |
Der Status der DSGVO-Zustimmung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Name
|
data.name | string |
Der Name. |
|
Email
|
data.email | string |
Die E-Mail-Adresse. |
|
Trichter
|
data.funnel | string |
Der Trichter. |
Abrufen eines kurzen Kursfortschrittsberichts
Ruft einen kurzen Bericht des Kursfortschritts ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Kurs-IDs
|
course_ids[] | string |
Die Kurs-IDs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Kurs-ID
|
data.items.course_number.courseId | integer |
Der Kursbezeichner. |
|
Startdatum
|
data.items.course_number.start_date | string |
Das Startdatum. |
|
Letztes Datum
|
data.items.course_number.last_date | string |
Das letzte Datum. |
|
Kursname
|
data.items.course_number.courseName | string |
Der Kursname. |
|
Schüler/Studenten insgesamt
|
data.items.course_number.total_students | integer |
Die Gesamtzahl der Kursteilnehmer. |
|
Nicht gestartet
|
data.items.course_number.not_started | integer |
Gibt an, ob begonnen wurde. |
|
In Bearbeitung
|
data.items.course_number.in_progress | integer |
Gibt an, ob in Bearbeitung ist. |
|
Abgeschlossen
|
data.items.course_number.completed | integer |
Gibt an, ob er abgeschlossen ist. |
|
Passrate
|
data.items.course_number.pass_rate | integer |
Die Passrate. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | string |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | string |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Abrufen eines kurzen Partnerberichts
Ruft einen kurzen Bericht von Verbundenen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Kurs-IDs
|
course_ids[] | string |
Die Kurs-IDs. |
|
|
Partner-IDs
|
affiliate_ids[] | string |
Die Partner-IDs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
Währung
|
data.items.currency | string |
Die Währung. |
|
Aff-ID
|
data.items.aff_id | string |
Der Partnerbezeichner. |
|
Aff-Name
|
data.items.aff_name | string |
Der Partnername. |
|
E-Mail senden
|
data.items.aff_email | string |
Die E-Mail-Adresse des Partners. |
|
Gesamtumsatzanzahl
|
data.items.total_sales_count | integer |
Die Gesamtzahl der Verkäufe. |
|
Gesamtkommission
|
data.items.total_commission | string |
Die Gesamtprovision. |
|
Ausstehende Kommission
|
data.items.pending_commission | string |
Die ausstehende Kommission. |
|
Bezahlte Provision
|
data.items.paid_commission | string |
Die bezahlte Provision. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | string |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | string |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Abrufen eines kurzen Registrierungsberichts
Ruft eine kurze Liste der Registrierungen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Kurs-ID
|
course_id | string |
Der Kursbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
Kurs-ID
|
data.items.course_id | integer |
Der Kursbezeichner. |
|
Kursname
|
data.items.course_name | string |
Der Kursname. |
|
Anzahl der Registrierungen
|
data.items.no_of_enrollments | integer |
Die Anzahl der Registrierungen. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Abrufen eines kurzen Verkaufsberichts
Ruft einen kurzen Bericht über verkäufe ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Gruppieren nach
|
groupby | string |
Die Gruppe nach. |
|
|
Kurs-IDs
|
course_ids | string |
Die Kurs-IDs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
Gesamtumsatz
|
data.items.total_sales | integer |
Der Gesamtumsatz. |
|
Kurs-ID
|
data.items.course_id | integer |
Der Kursbezeichner. |
|
Ergebnissumme
|
data.items.earnings_total | string |
Die Ergebnissumme. |
|
Gesamtumsatz
|
data.items.sales_total | string |
Die Gesamtsumme des Umsatzes. |
|
Aff-Gebühr
|
data.items.aff_fee | string |
Die Partnergebühr. |
|
Name
|
data.items.name | string |
Der Name. |
|
Day
|
data.items.day | string |
Der Tag. |
|
Month
|
data.items.month | string |
Der Monat. |
|
Währung
|
data.items.currency | string |
Die Währung. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Abrufen von Benutzerdetails
Abrufen von Informationen zu einem Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user_id | True | string |
Der Benutzerbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Vorname
|
data.first_name | string |
Der Vorname. |
|
Nachname
|
data.last_name | string |
Der Nachname. |
|
Email
|
data.email | string |
Die E-Mail-Adresse. |
|
Biografie
|
data.bio | string |
Die Biografie. |
|
Adresse
|
data.address | string |
Die Adresse. |
|
Stadt
|
data.city | string |
Die Stadt. |
|
Staat
|
data.state | string |
Der Staat. |
|
PLZ
|
data.zip_code | string |
Die Postleitzahl. |
|
Rollen
|
data.roles | array of integer | |
|
Telefonnummer
|
data.phone | string |
Die Telefonnummer. |
Abrufen von Registrierungen für einen Trichter
Ruft eine Liste der Registrierungen für einen Trichter ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Trichter-ID
|
funnel_id | True | string |
Der Trichterbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
ID
|
data.items.id | string |
Der Bezeichner. |
|
Vorname
|
data.items.first_name | string |
Der Vorname. |
|
Nachname
|
data.items.last_name | string |
Der Nachname. |
|
Email
|
data.items.email | string |
Die E-Mail-Adresse. |
|
Registriert am
|
data.items.enrolled_on | string |
Bei der Registrierung. |
Abrufen von Trichtern
Ruft eine Liste von Trichtern ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Bestellung nach
|
orderby | string |
Die Reihenfolge nach Feld. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Suche
|
search | string |
Der Suchbegriff. |
|
|
Der Status
|
status | integer |
Der Status. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
Der Bezeichner. |
|
Name
|
data.items.name | string |
Der Name. |
|
Typ
|
data.items.type | string |
Der Typ. |
|
URL
|
data.items.url | string |
Die URL-Adresse. |
|
Gesamtleitungen
|
data.items.total_leads | integer |
Die Gesamtanzahl der Leads. |
|
Vorschauminiatur
|
data.items.thumbnail | string |
Die Miniaturansicht. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Anstehende Kurse erhalten
Ruft eine Liste der anstehenden Live-Kurse ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Bestellung nach
|
orderby | string |
Die Reihenfolge nach Feld. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Suche
|
search | string |
Der Suchbegriff. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
Der Bezeichner. |
|
Thema
|
data.items.topic | string |
Das Thema. |
|
Terminplandatum
|
data.items.schedule_date | string |
Das Zeitplandatum. |
|
Timezone
|
data.items.timezone | string |
Die Zeitzone. |
|
Dauer
|
data.items.duration | integer |
Die Dauer. |
|
Url registrieren
|
data.items.register_url | string |
Die URL-Adresse des Registers. |
|
Serie
|
data.items.recurring | boolean |
Gibt an, ob die Serie wiederholt wird. |
|
Aktueller Terminplan
|
data.items.recent_recurring_schedule | string |
Der aktuelle Terminplan. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Anstehende Webinare erhalten
Dient zum Abrufen einer Liste anstehender Live-Webinare.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Bestellung nach
|
orderby | string |
Die Reihenfolge nach Feld. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Suche
|
search | string |
Der Suchbegriff. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
Der Bezeichner. |
|
Thema
|
data.items.topic | string |
Das Thema. |
|
Terminplandatum
|
data.items.schedule_date | string |
Das Zeitplandatum. |
|
Timezone
|
data.items.timezone | string |
Die Zeitzone. |
|
Dauer
|
data.items.duration | integer |
Die Dauer. |
|
Url registrieren
|
data.items.register_url | string |
Die URL-Adresse des Registers. |
|
Serie
|
data.items.recurring | boolean |
Gibt an, ob die Serie wiederholt wird. |
|
Aktueller Terminplan
|
data.items.recent_recurring_schedule | string |
Der aktuelle Terminplan. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Aufheben der Registrierung eines Benutzers
Hebt die Registrierung eines Benutzers aus einem Kurs auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user_id | True | string |
Der Benutzerbezeichner. |
|
Kurs-ID
|
course_id | True | string |
Der Kursbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Nachricht
|
data.message | string |
Die Nachricht. |
Aufheben der Registrierung für den Kurs
Heben Sie die Registrierung eines Benutzers für eine Liveklasse auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Live Class ID
|
liveclass_id | True | string |
Der Live-Klassenbezeichner. |
|
Email
|
string |
Die E-Mail. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Daten
|
data | string |
Die Daten. |
Benutzer aktualisieren
Aktualisiert die Informationen eines Benutzers.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user_id | True | string |
Der Benutzerbezeichner. |
|
Vorname
|
first_name | True | string |
Der Vorname. |
|
Nachname
|
last_name | True | string |
Der Nachname. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Kennwort
|
password | True | string |
Das Kennwort. |
|
Provision
|
commission | True | integer |
Die Kommission. |
|
Rollen
|
roles | True | string |
Die Rollen. |
|
Adresse
|
address | string |
Die Adresse. |
|
|
Stadt
|
city | string |
Die Stadt. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Telefonnummer
|
phone | string |
Die Telefonnummer. |
|
|
PLZ
|
zip_code | integer |
Die Postleitzahl. |
|
|
Country
|
country | string |
Das Land. |
|
|
DSGVO-Zustimmungsstatus
|
gdpr_consent_status | integer |
Der Status der DSGVO-Zustimmung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Nachricht
|
data.message | string |
Die Nachricht. |
Benutzer hinzufügen
Erstellt einen neuen Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorname
|
first_name | True | string |
Der Vorname. |
|
Nachname
|
last_name | True | string |
Der Nachname. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Kennwort
|
password | True | string |
Das Kennwort. |
|
Provision
|
commission | True | integer |
Die Kommission. |
|
Rollen
|
roles | True | string |
Die Rollen. |
|
Adresse
|
address | string |
Die Adresse. |
|
|
Stadt
|
city | string |
Die Stadt. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Telefonnummer
|
phone | string |
Die Telefonnummer. |
|
|
PLZ
|
zip_code | integer |
Die Postleitzahl. |
|
|
Country
|
country | string |
Das Land. |
|
|
DSGVO-Zustimmungsstatus
|
gdpr_consent_status | integer |
Der Status der DSGVO-Zustimmung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Vorname
|
data.first_name | string |
Der Vorname. |
|
Nachname
|
data.last_name | string |
Der Nachname. |
|
Email
|
data.email | string |
Die E-Mail-Adresse. |
Benutzerliste abrufen
Ruft eine Liste der Benutzer ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Bestellung nach
|
orderby | string |
Die Reihenfolge nach Feld. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Suche
|
search | string |
Der Suchbegriff. |
|
|
Rolle
|
role | integer |
Die Rolle. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
ID
|
data.items.id | string |
Der Bezeichner. |
|
Vorname
|
data.items.first_name | string |
Der Vorname. |
|
Nachname
|
data.items.last_name | string |
Der Nachname. |
|
Email
|
data.items.email | string |
Die E-Mail-Adresse. |
|
Rollen
|
data.items.roles | array of integer |
Die Rollen. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Detaillierter Kursfortschrittsbericht abrufen
Ruft einen detaillierten Bericht des Kursfortschritts ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Kurs-IDs
|
course_ids[] | string |
Die Kurs-IDs. |
|
|
Erweiterter Filter
|
af_v | string |
Der erweiterte Filter. |
|
|
Kupon ist
|
coupon_is[] | string |
Der Coupon ist. |
|
|
Kupon wie
|
coupon_like[] | string |
Der Coupon ist wie. |
|
|
Name ist
|
name_is[] | string |
Der Name lautet. |
|
|
Name wie
|
name_like[] | string |
Der Name ist wie folgt. |
|
|
E-Mail ist
|
email_is[] | string |
Die E-Mail lautet. |
|
|
E-Mail wie
|
email_like[] | string |
Die E-Mail ist wie folgt. |
|
|
Partner ist
|
affiliate_is[] | string |
Der Partner ist. |
|
|
Zahlungsmethode
|
payment_type | integer |
Der Zahlungstyp. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
UID
|
data.items.course_number.uid | string |
Der eindeutige Bezeichner. |
|
Kurs-ID
|
data.items.course_number.courseId | string |
Der Kursbezeichner. |
|
Name
|
data.items.course_number.name | string |
Der Name. |
|
Email
|
data.items.course_number.email | string |
Die E-Mail-Adresse. |
|
Registrierungsdatum
|
data.items.course_number.enrollment_date | string |
Das Registrierungsdatum. |
|
Startdatum
|
data.items.course_number.start_date | string |
Das Startdatum. |
|
Abgeschlossen am
|
data.items.course_number.completed_date | string |
Das Abgeschlossene Datum. |
|
Der Status
|
data.items.course_number.status | string |
Der Status. |
|
Zuletzt besucht
|
data.items.course_number.last_attended | string |
Bei letzter Teilnahme. |
|
Fertigstellungsprozentsatz
|
data.items.course_number.completion_percentage | integer |
Der Prozentsatz der Fertigstellung. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | string |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | string |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Detaillierter Partnerbericht abrufen
Ruft einen detaillierten Bericht von Verbundenen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Kurs-IDs
|
course_ids[] | string |
Die Kurs-IDs. |
|
|
Partner-IDs
|
affiliate_ids[] | string |
Die Partner-IDs. |
|
|
Erweiterter Filter
|
af_v | string |
Der erweiterte Filter. |
|
|
Kupon ist
|
coupon_is[] | string |
Der Coupon ist. |
|
|
Kupon wie
|
coupon_like[] | string |
Der Coupon ist wie. |
|
|
Name ist
|
name_is[] | string |
Der Name lautet. |
|
|
Name wie
|
name_like[] | string |
Der Name ist wie folgt. |
|
|
E-Mail ist
|
email_is[] | string |
Die E-Mail lautet. |
|
|
E-Mail wie
|
email_like[] | string |
Die E-Mail ist wie folgt. |
|
|
Partner ist
|
affiliate_is[] | string |
Der Partner ist. |
|
|
Zahlungsmethode
|
payment_type | string |
Der Zahlungstyp. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
Kurs
|
data.items.course | string |
Der Kurs. |
|
Erstellt unter
|
data.items.created_at | string |
Beim Erstellen bei. |
|
Verkaufspreis
|
data.items.sales_price | string |
Der Verkaufspreis. |
|
Couponrabatt
|
data.items.coupon_discount | string |
Der Couponrabatt. |
|
Provision
|
data.items.commission | string |
Die Kommission. |
|
Auszahlungsstatus
|
data.items.payout_status | string |
Der Auszahlungsstatus. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Detaillierter Registrierungsbericht abrufen
Ruft eine detaillierte Liste der Registrierungen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Kurs-ID
|
course_id | string |
Der Kursbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
Kurs-ID
|
data.items.course_id | integer |
Der Kursbezeichner. |
|
Benutzer-ID
|
data.items.user_id | string |
Der Benutzerbezeichner. |
|
Kursname
|
data.items.course_name | string |
Der Kursname. |
|
Vorname
|
data.items.first_name | string |
Der Vorname. |
|
Nachname
|
data.items.last_name | string |
Der Nachname. |
|
Email
|
data.items.email | string |
Die E-Mail-Adresse. |
|
Registrierungsdatum
|
data.items.enrollment_date | string |
Das Registrierungsdatum. |
Detaillierter Umsatzbericht abrufen
Ruft einen detaillierten Umsatzbericht ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Startdatum
|
start_date | string |
Das Startdatum. |
|
|
Enddatum
|
end_date | string |
Das Enddatum. |
|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Kurs-IDs
|
course_ids | string |
Die Kurs-IDs. |
|
|
Zahlungsmethode
|
payment_type | integer |
Der Zahlungstyp. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
Erstellt unter
|
data.items.created_at | string |
Beim Erstellen bei. |
|
Buchungskennung
|
data.items.transaction_id | string |
Der Transaktionsbezeichner. |
|
Verkaufspreis
|
data.items.sales_price | string |
Der Verkaufspreis. |
|
Ertragspreis
|
data.items.earn_price | string |
Der Ertragspreis. |
|
Name des Kursteilnehmers
|
data.items.student_name | string |
Der Name des Kursteilnehmers. |
|
Schüler-E-Mail
|
data.items.student_email | string |
Die E-Mail-Adresse des Kursteilnehmers. |
|
Kurs
|
data.items.course | string |
Der Kurs. |
|
Kurs-ID
|
data.items.course_id | integer |
Der Kursbezeichner. |
|
Couponcode
|
data.items.coupon_code | string |
Der Couponcode. |
|
Zahlungsgateway
|
data.items.payment_gateway | string |
Das Zahlungsgateway. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Für den Kurs registrieren
Registrieren sie einen Benutzer für eine Live-Klasse.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Live Class ID
|
liveclass_id | True | string |
Der Live-Klassenbezeichner. |
|
Name
|
name | True | string |
Der Name. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Nachname
|
last_name | string |
Der Nachname. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Name
|
data.name | string |
Der Name. |
|
Email
|
data.email | string |
Die E-Mail-Adresse. |
|
Live-Klasse
|
data.live class | string |
Der Live-Kurs. |
|
Nachricht
|
data.message | string |
Die Nachricht. |
Kurs abrufen
Ruft einen Kurs nach Kursbezeichner ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kurs-ID
|
course_id | True | string |
Der Kursbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
ID
|
data.items.id | integer |
Der Bezeichner. |
|
Name
|
data.items.name | string |
Der Name. |
|
Untertitel
|
data.items.subtitle | string |
Der Untertitel. |
|
Vorschauminiatur
|
data.items.thumbnail | string |
Die Miniaturansicht. |
|
Kurstyp
|
data.items.course_type | integer |
Der Kurstyp. |
|
Besitzer
|
data.items.owner | string |
Der Besitzer. |
|
Schul-ID
|
data.items.school_id | integer |
Der Schulbezeichner. |
|
Öffentlichkeit
|
data.items.public | integer |
Gibt an, ob öffentlich. |
|
Befähigt
|
data.items.featured | integer |
Gibt an, ob empfohlen. |
|
Versteckt
|
data.items.hidden | integer |
Ob ausgeblendet. |
|
Privat
|
data.items.private | integer |
Ob privat. |
Liste der Kurse abrufen
Ruft eine Liste von Kursen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Seite
|
page | integer |
Die Seitenzahl. |
|
|
Bestellung nach
|
orderby | string |
Die Reihenfolge nach Feld. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Suche
|
search | string |
Der Suchbegriff. |
|
|
Typ
|
type | integer |
Der Typ. |
|
|
Der Status
|
status | integer |
Der Status. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Gegenstände
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
Der Bezeichner. |
|
Name
|
data.items.name | string |
Der Name. |
|
Untertitel
|
data.items.subtitle | string |
Der Untertitel. |
|
Vorschauminiatur
|
data.items.thumbnail | string |
Die Miniaturansicht. |
|
URL
|
data.items.url | string |
Die URL-Adresse. |
|
Elemente insgesamt
|
data.pagination.total_items | integer |
Die Gesamtzahl der Elemente. |
|
Elemente pro Seite
|
data.pagination.items_per_page | integer |
Die Elemente pro Seite. |
|
Seitenindex
|
data.pagination.page_index | integer |
Der Seitenindex. |
|
Seiten insgesamt
|
data.pagination.total_pages | integer |
Die Gesamtzahl der Seiten. |
Löschen eines Benutzers
Entfernen Sie einen Benutzer aus Ihrem Konto.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user_id | True | string |
Der Benutzerbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Daten
|
data | string |
Die Daten. |
Registrieren eines Benutzers
Registriert einen Benutzer für einen Kurs.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user_id | True | string |
Der Benutzerbezeichner. |
|
Kurs-ID
|
course_id | True | string |
Der Kursbezeichner. |
|
Plan-ID
|
plan_id | string |
Der Planbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Daten
|
data | string |
Die Daten. |
Registrieren für Webinar
Registrieren Sie einen Benutzer für ein Live-Webinar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Webinar-ID
|
webinar_id | True | string |
Der Webinarbezeichner. |
|
Name
|
name | True | string |
Der Name. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Nachname
|
last_name | string |
Der Nachname. |
|
|
Adresse
|
address | string |
Die Adresse. |
|
|
Stadt
|
city | string |
Die Stadt. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Telefonnummer
|
phone | string |
Die Telefonnummer. |
|
|
PLZ
|
zip_code | integer |
Die Postleitzahl. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Name
|
data.name | string |
Der Name. |
|
Email
|
data.email | string |
Die E-Mail-Adresse. |
|
Live-Webinar
|
data.live webinar | string |
Das Live-Webinar. |
|
Nachricht
|
data.message | string |
Die Nachricht. |
Registrierung für Webinar aufheben
Heben Sie die Registrierung eines Benutzers für ein Live-Webinar auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Webinar-ID
|
webinar_id | True | string |
Der Webinarbezeichner. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwortcode
|
response_code | integer |
Der Antwortcode. |
|
Nachricht
|
message | string |
Die Antwortnachricht. |
|
Daten
|
data | string |
Die Daten. |