Eduframe
Eduframe to kompletne rozwiązanie dla komercyjnych dostawców szkoleń i szkół biznesowych, aby przyciągnąć więcej uczniów, zarządzać i automatyzować administrację kursu i dostarczać najlepsze środowisko szkoleniowe. Program Eduframe bezproblemowo integruje się z aplikacją Canvas LMS. Łącznik otwiera możliwość łatwego zintegrowania istniejących aplikacji oprogramowania z oprogramowaniem Eduframe, takich jak oprogramowanie CRM i księgowość.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Zespół deweloperów Eduframe |
| adres URL | https://eduframe.co |
| dev@drieam.nl |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://eduframe.co |
| Zasady ochrony prywatności | https://drieam.com/security-and-privacy/ |
| Kategorie | Dane |
Eduframe zarządza i automatyzuje administrowanie kursem dla komercyjnych dostawców szkoleń i szkół biznesowych. Korzystając z tego łącznika, można połączyć różne narzędzia razem z programem Eduframe, aby automatycznie zarządzać kursami, użytkownikami, fakturami i nie tylko.
Wymagania wstępne
Aby korzystać z tego łącznika, musisz mieć licencję Eduframe. Więcej informacji na temat programu Eduframe i sposobu uzyskania licencji można znaleźć tutaj.
Jeśli masz już licencję Eduframe, upewnij się, że usługa Azure Logic Apps jest włączona dla danego środowiska. Jeśli chcesz włączyć tę integrację, możesz wysłać wiadomość e-mail na adres .support@eduframe.nl
Jak uzyskać poświadczenia
Jeśli używasz tego łącznika po raz pierwszy, zostanie wyświetlony monit o zalogowanie się do programu Eduframe i autoryzowanie tego łącznika. Po autoryzacji będzie można używać tego łącznika i wszystkich jego funkcji.
Wprowadzenie do łącznika
Program Eduframe udostępnia elementy webhook, które działają jako wyzwalacze dla automatyzacji. Możemy utworzyć nowy przepływ, który będzie wyzwalany za każdym razem, gdy nowy użytkownik zostanie dodany do środowiska Eduframe. Podczas tworzenia nowego przepływu możesz wybrać ten łącznik i wybrać pozycję "Subskrybuj element webhook" jako wyzwalacz. Następnie w obszarze "element zdarzeń" wybierz pozycję "user.created". Możesz dodać więcej, ale na razie jesteśmy zainteresowani tylko tym.
Następnie chcemy wiedzieć, który użytkownik został dodany do elementu eduframe. W tym celu możemy dodać nowy krok z tego łącznika o nazwie "Pobierz użytkownika". Ten krok będzie wymagał identyfikatora od użytkownika. Możemy użyć identyfikatora jednostki z elementu webhook.
Teraz, gdy wiemy, kto jest nowym użytkownikiem programu Eduframe, możemy wysłać tę osobę pocztą e-mail. Na przykład użyjemy łącznika programu Outlook, ale może to być dowolny dostawca poczty. Dodaj nowy krok i wybierz pozycję "Wyślij wiadomość e-mail". W tym miejscu możemy wypełnić wiadomość e-mail od użytkownika, tematu i wiadomości e-mail, którą chcemy wysłać. Pamiętaj, że w treści wiadomości e-mail możesz użyć innych atrybutów od użytkownika, takich jak imię i nazwisko.
Gdy skończymy pisać wiadomość e-mail, możemy zapisać ten przepływ. Teraz za każdym razem, gdy nowy użytkownik zostanie dodany do programu Eduframe, ta osoba otrzyma powitalną wiadomość e-mail.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Dodawanie faktury |
Dodaj fakturę do administracji. |
| Dodawanie kategorii |
Dodaj kategorię do administracji. |
| Dodawanie konta |
Dodaj konto do administracji. |
| Dodawanie kursu |
Dodaj kurs do administracji. |
| Dodawanie uwierzytelniania |
Dodawanie metody uwierzytelniania do istniejącego użytkownika |
| Dodawanie użytkownika |
Dodaj użytkownika do administracji. |
| Dodawanie vat faktury |
Dodaj vat na fakturze, który może być używany na fakturze. |
| Pobieranie faktury |
Pobierz jedną fakturę według identyfikatora. |
| Pobieranie kategorii |
Pobieranie kategorii według identyfikatora |
| Pobieranie uwierzytelniania użytkownika |
Pobierz listę uwierzytelnień należących do określonego użytkownika. |
| Pobieranie użytkownika |
Pobierz jednego użytkownika według identyfikatora. |
| Pobieranie wszystkich wariantów wykazu |
Pobierz wszystkie warianty wykazu. |
| Usuwanie uwierzytelniania użytkownika |
Usuń jedno z uwierzytelnień użytkownika. Pamiętaj, że nie można usunąć ostatniego uwierzytelniania! |
| Uzyskaj kurs |
Uzyskiwanie pojedynczego kursu według identyfikatora |
| Uzyskiwanie konta |
Pobierz konto według identyfikatora. |
| Wyświetl listę wszystkich kategorii |
Pobierz wszystkie kategorie. |
| Wyświetl listę wszystkich kursów |
Uzyskaj wszystkie kursy. |
| Wyświetl listę wszystkich użytkowników |
Pobierz wszystkich użytkowników. |
| Wyświetlanie listy wszystkich etykiet |
Pobierz wszystkie etykiety. |
| Wyświetlanie listy wszystkich faktur |
Pobierz wszystkie faktury. |
| Wyświetlanie listy wszystkich kont |
Pobierz wszystkie konta. |
| Wyświetlanie listy wszystkich vatów na fakturze |
Pobieranie wszystkich vatów na fakturze |
Dodawanie faktury
Dodaj fakturę do administracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Rachunek
|
account_id | True | number |
Identyfikator konta. |
|
account_name
|
account_name | string |
Nazwa konta, które płaci. Jest kopiowany na fakturę i dlatego nie jest automatycznie aktualizowany, jeśli nazwa konta ulegnie zmianie. |
|
|
waluta
|
currency | True | string |
Waluta faktury. |
|
id
|
id | integer |
Unikatowy identyfikator elementu faktury. |
|
|
Units
|
units | True | number |
Liczba jednostek elementu faktury. |
|
Description
|
name | True | string |
Nazwa elementu faktury. |
|
Cena
|
unit_price | True | string |
Cena pojedynczej jednostki. |
|
VAT
|
invoice_vat_id | number |
Identyfikator vat faktury. |
|
|
Wariant wykazu
|
catalog_variant_id | number |
Identyfikator wariantu wykazu. |
|
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
|
|
cecha
|
feature | string |
Opis faktury wyświetlanej na fakturze. |
|
|
przypis
|
footnote | string |
Notatka wyświetlana w dolnej części faktury. |
Zwraca
- Body
- invoice
Dodawanie kategorii
Dodaj kategorię do administracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator kategorii. |
|
|
Name
|
name | True | string |
Tytuł kategorii. |
|
Description
|
description | string |
Opis kategorii. |
|
|
pozycja
|
position | number |
Pozycja sortowania kategorii. Niższa jest wyższa. |
|
|
parent_id
|
parent_id | number |
Unikatowy identyfikator kategorii nadrzędnej |
|
|
awatar
|
avatar | string |
Adres URL do awatara kategorii. |
|
|
Opublikowany
|
is_published | boolean |
Jeśli kategoria powinna zostać opublikowana w witrynie internetowej. |
|
|
courses_count
|
courses_count | number |
Liczba kursów połączonych bezpośrednio z tą kategorią. |
|
|
children_count
|
children_count | number |
Liczba kategorii podrzędnych połączonych bezpośrednio z tą kategorią. |
|
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
|
|
avatar_url
|
avatar_url | string |
Adres URL obrazu awatara o zmienionym rozmiarze (300x200^). |
Zwraca
- Body
- category
Dodawanie konta
Dodaj konto do administracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | True | string |
Nazwa konta. |
|
e-mail
|
string |
Ciąg reprezentujący adres e-mail rozliczeń konta. |
||
|
id
|
id | integer |
Unikatowy identyfikator adresu. |
|
|
adresat
|
addressee | string |
Adres adresu. |
|
|
address
|
address | True | string |
Łączenie ulicy i numeru domu. |
|
kod pocztowy
|
postal_code | True | string |
Ciąg reprezentujący kod pocztowy. |
|
city
|
city | True | string |
Ciąg reprezentujący miasto. |
|
country
|
country | True | string |
Ciąg reprezentujący kraj. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
Zwraca
- Body
- account
Dodawanie kursu
Dodaj kurs do administracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator kursu |
|
|
nazwa
|
name | True | string |
Nazwa kursu. |
|
pozycja
|
position | number |
Pozycja sortowania kursu. Niższa jest wyższa. |
|
|
signup_url
|
signup_url | string |
Adres URL strony rejestracji dla tego kursu. |
|
|
slug_history
|
slug_history | array of string |
Lista starych ślimaków, stare wywołania zostaną przekierowane. |
|
|
awatar
|
avatar | string |
Adres URL obrazu awatara o zmienionym rozmiarze (300x200^). |
|
|
certificate_template_id
|
certificate_template_id | number |
Identyfikator opcjonalnego połączonego szablonu certyfikatu. |
|
|
Kategoria
|
category_id | True | number |
Identyfikator kategorii kursu. |
|
kod
|
code | True | string |
Kod kursu. |
|
koszt
|
cost | string |
Cena do zapłaty za ten kurs. |
|
|
cost_scheme
|
cost_scheme | string |
Jak kurs powinien być opłacany domyślnie. |
|
|
is_published
|
is_published | boolean |
Wartość logiczna reprezentująca stan publikowania kursu. |
|
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
Zwraca
- Body
- course
Dodawanie uwierzytelniania
Dodawanie metody uwierzytelniania do istniejącego użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
user_id
|
user_id | True | integer |
Identyfikator użytkownika, do którego należy to uwierzytelnianie. |
|
authentication_provider_type
|
authentication_provider_type | True | string |
Typ dostawcy uwierzytelniania. |
|
uid
|
uid | True | string |
Unikatowy identyfikator tego uwierzytelniania, który odpowiada unikatowego identyfikatora dostawcy tożsamości. |
Zwraca
- Body
- authentication
Dodawanie użytkownika
Dodaj użytkownika do administracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Imię
|
first_name | True | string |
Imię użytkownika. |
|
Drugie imię
|
middle_name | string |
Nazwa środkowa użytkownika. |
|
|
Nazwisko
|
last_name | True | string |
Nazwisko użytkownika. |
|
Email
|
True | string |
Adres e-mail użytkownika. |
|
|
Numer telefonu
|
phone | string |
Numer telefonu użytkownika. |
|
|
Subskrybowanie biuletynu
|
wants_newsletter | boolean |
Czy użytkownik chce otrzymywać biuletyny? |
|
|
Tworzenie uwierzytelniania
|
with_authentication | boolean |
Utwórz uwierzytelnianie dla użytkownika, tak aby użytkownik mógł się zalogować. |
|
|
regionalny
|
locale | string |
Ustawienia regionalne użytkownika. |
|
|
label_ids
|
label_ids | array of number | ||
|
id
|
id | integer |
Unikatowy identyfikator adresu. |
|
|
adresat
|
addressee | string |
Adres adresu. |
|
|
address
|
address | True | string |
Łączenie ulicy i numeru domu. |
|
kod pocztowy
|
postal_code | True | string |
Ciąg reprezentujący kod pocztowy. |
|
city
|
city | True | string |
Ciąg reprezentujący miasto. |
|
country
|
country | True | string |
Ciąg reprezentujący kraj. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
|
|
notes_user
|
notes_user | string |
Krótka uwaga dotycząca użytkownika. |
Zwraca
- Body
- user
Dodawanie vat faktury
Dodaj vat na fakturze, który może być używany na fakturze.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | integer |
Unikatowy idenitfikator vat faktury. |
|
|
nazwa
|
name | True | string |
Nazwa vat faktury. |
|
procent
|
percentage | True | string |
Liczba reprezentująca wartość procentową podatku VAT. |
Zwraca
- Body
- invoice_vat
Pobieranie faktury
Pobierz jedną fakturę według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator faktury
|
id | True | integer |
Identyfikator faktury. |
Zwraca
- Body
- invoice
Pobieranie kategorii
Pobieranie kategorii według identyfikatora
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kategorii
|
id | True | integer |
Identyfikator kategorii. |
Zwraca
- Body
- category
Pobieranie uwierzytelniania użytkownika
Pobierz listę uwierzytelnień należących do określonego użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
|
|
Identyfikator użytkownika
|
user_id | True | integer |
Identyfikator użytkownika. |
Zwraca
- response
- array of authentication
Pobieranie użytkownika
Pobierz jednego użytkownika według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
id | True | integer |
Identyfikator użytkownika. |
Zwraca
- Body
- user
Pobieranie wszystkich wariantów wykazu
Pobierz wszystkie warianty wykazu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
Zwraca
- response
- array of catalog_variant
Usuwanie uwierzytelniania użytkownika
Usuń jedno z uwierzytelnień użytkownika. Pamiętaj, że nie można usunąć ostatniego uwierzytelniania!
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
user_id | True | integer |
Identyfikator użytkownika. |
|
Identyfikator uwierzytelniania
|
authentication_id | True | integer |
Identyfikator uwierzytelniania. |
Uzyskaj kurs
Uzyskiwanie pojedynczego kursu według identyfikatora
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kursu
|
id | True | integer |
Identyfikator kursu. |
Zwraca
- Body
- course
Uzyskiwanie konta
Pobierz konto według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
id | True | integer |
Identyfikator konta. |
Zwraca
- Body
- account
Wyświetl listę wszystkich kategorii
Pobierz wszystkie kategorie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
|
|
Sortuj
|
sort | array |
Posortuj wyniki. Zmień kolejność przy użyciu polecenia |
Zwraca
- response
- array of category
Wyświetl listę wszystkich kursów
Uzyskaj wszystkie kursy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
|
|
Sortuj
|
sort | array |
Posortuj wyniki. Zmień kolejność przy użyciu polecenia |
Zwraca
- response
- array of course
Wyświetl listę wszystkich użytkowników
Pobierz wszystkich użytkowników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
|
|
Sortuj
|
sort | array |
Posortuj wyniki. Zmień kolejność przy użyciu polecenia |
Zwraca
- response
- array of user
Wyświetlanie listy wszystkich etykiet
Pobierz wszystkie etykiety.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
|
|
Filtruj według typu modelu etykiety
|
model_type | string |
Filtrowanie etykiet na podstawie typu modelu. |
Zwraca
- response
- array of label
Wyświetlanie listy wszystkich faktur
Pobierz wszystkie faktury.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
Zwraca
- response
- array of invoice
Wyświetlanie listy wszystkich kont
Pobierz wszystkie konta.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
Zwraca
- response
- array of account
Wyświetlanie listy wszystkich vatów na fakturze
Pobieranie wszystkich vatów na fakturze
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
page | integer |
Numer strony do pobrania. |
|
|
Rekordy na stronę
|
per_page | integer |
Liczba rekordów na stronę. |
Zwraca
- response
- array of invoice_vat
Wyzwalacze
| Subskrybowanie elementu webhook |
Subskrybuj element webhook, aby otrzymywać powiadomienia o aktualizacjach rekordów. |
Subskrybowanie elementu webhook
Subskrybuj element webhook, aby otrzymywać powiadomienia o aktualizacjach rekordów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator elementu webhook. (identyfikator UUID). |
|
|
aktywny
|
active | boolean |
Stan elementu webhook. |
|
|
events
|
events | True | array of string |
Tablica zdarzeń, które powinny wyzwalać ten element webhook. |
Zwraca
- Body
- webhook_payload
Definicje
konto
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator konta. |
|
nazwa
|
name | string |
Nazwa konta. |
|
e-mail
|
string |
Ciąg reprezentujący adres e-mail rozliczeń konta. |
|
|
account_type
|
account_type | string |
Typ konta. |
|
address
|
address | address | |
|
phone
|
phone | string |
Ciąg reprezentujący numer telefonu konta. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
|
signup_answers
|
signup_answers | array of customField |
Lista odpowiedzi dotyczących rejestracji dla tego konta. |
address
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator adresu. |
|
adresat
|
addressee | string |
Adres adresu. |
|
address
|
address | string |
Łączenie ulicy i numeru domu. |
|
kod pocztowy
|
postal_code | string |
Ciąg reprezentujący kod pocztowy. |
|
city
|
city | string |
Ciąg reprezentujący miasto. |
|
country
|
country | string |
Ciąg reprezentujący kraj. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
uwierzytelnianie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator uwierzytelniania. |
|
user_id
|
user_id | integer |
Identyfikator użytkownika, do którego należy to uwierzytelnianie. |
|
authentication_provider_id
|
authentication_provider_id | integer |
Identyfikator dostawcy uwierzytelniania. |
|
uid
|
uid | string |
Unikatowy identyfikator tego uwierzytelniania, który odpowiada unikatowego identyfikatora dostawcy tożsamości. |
|
Jeśli dla tego identyfikatora logowania włączono protokół OTP.
|
otp_enabled |
Jeśli dostawca uwierzytelniania jest eduframe, wskazuje, czy dla każdego innego dostawcy jest włączone jednorazowe hasło do tego logowania, jest fałszywe. |
|
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator odpowiedzi na rejestrację. |
|
value
|
value | string |
Sformatowana wartość odpowiedzi. |
|
signup_question_id
|
signup_question_id | integer |
Unikatowy identyfikator pytania. |
kategoria
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator kategorii. |
|
Name
|
name | string |
Tytuł kategorii. |
|
Description
|
description | string |
Opis kategorii. |
|
pozycja
|
position | number |
Pozycja sortowania kategorii. Niższa jest wyższa. |
|
parent_id
|
parent_id | number |
Unikatowy identyfikator kategorii nadrzędnej |
|
awatar
|
avatar | string |
Adres URL do awatara kategorii. |
|
Opublikowany
|
is_published | boolean |
Jeśli kategoria powinna zostać opublikowana w witrynie internetowej. |
|
courses_count
|
courses_count | number |
Liczba kursów połączonych bezpośrednio z tą kategorią. |
|
children_count
|
children_count | number |
Liczba kategorii podrzędnych połączonych bezpośrednio z tą kategorią. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
|
avatar_url
|
avatar_url | string |
Adres URL obrazu awatara o zmienionym rozmiarze (300x200^). |
kurs
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator kursu |
|
nazwa
|
name | string |
Nazwa kursu. |
|
pozycja
|
position | number |
Pozycja sortowania kursu. Niższa jest wyższa. |
|
signup_url
|
signup_url | string |
Adres URL strony rejestracji dla tego kursu. |
|
awatar
|
avatar | string |
Adres URL obrazu awatara o zmienionym rozmiarze (300x200^). |
|
certificate_template_id
|
certificate_template_id | number |
Identyfikator opcjonalnego połączonego szablonu certyfikatu. |
|
Kategoria
|
category_id | number |
Identyfikator kategorii kursu. |
|
kod
|
code | string |
Kod kursu. |
|
koszt
|
cost | string |
Cena do zapłaty za ten kurs. |
|
cost_scheme
|
cost_scheme | string |
Jak kurs powinien być opłacany domyślnie. |
|
is_published
|
is_published | boolean |
Wartość logiczna reprezentująca stan publikowania kursu. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
użytkownik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator użytkownika. |
|
Numer pracownika
|
employee_number | string |
Numer pracownika tego użytkownika. |
|
Imię
|
first_name | string |
Imię użytkownika. |
|
Drugie imię
|
middle_name | string |
Nazwa środkowa użytkownika. |
|
Nazwisko
|
last_name | string |
Nazwisko użytkownika. |
|
Email
|
string |
Adres e-mail użytkownika. |
|
|
Numer telefonu
|
phone | string |
Numer telefonu użytkownika. |
|
labels
|
labels | array of label | |
|
Subskrybowanie biuletynu
|
wants_newsletter | boolean |
Czy użytkownik chce otrzymywać biuletyny? |
|
Tworzenie uwierzytelniania
|
with_authentication | boolean |
Utwórz uwierzytelnianie dla użytkownika, tak aby użytkownik mógł się zalogować. |
|
regionalny
|
locale | string |
Ustawienia regionalne użytkownika. |
|
address
|
address | address | |
|
Awatar
|
avatar_url | string |
Względna ścieżka adresu URL do awatara. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
faktura
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator faktury. |
|
reference_id
|
reference_id | string |
Identyfikator odwołania faktury. Służy do znajdowania faktury. |
|
Rachunek
|
account_id | number |
Identyfikator konta. |
|
Liczba
|
number | string |
Numer faktury, który jest unikatowy dla nauczyciela. W przypadku pozostawienia pustego autoinkrementuje. |
|
number_int
|
number_int | number |
Numer faktury przekonwertowany na wartość całkowitą. |
|
stan
|
status | string |
Stan faktury. Początkowy stan będzie zawsze pojęciem. |
|
expiration_date
|
expiration_date | string |
Data wygaśnięcia faktury. Jest ustawiana, gdy faktura ma być otwarta. |
|
opened_at
|
opened_at | string |
Data zmiany stanu faktury na otwarcie. |
|
opis
|
description | string |
Czytelny opis faktury. |
|
account_name
|
account_name | string |
Nazwa konta, które płaci. Jest kopiowany na fakturę i dlatego nie jest automatycznie aktualizowany, jeśli nazwa konta ulegnie zmianie. |
|
waluta
|
currency | string |
Waluta faktury. |
|
total_incl
|
total_incl | string |
Całkowity koszt faktury, w tym VAT. |
|
total_excl
|
total_excl | string |
Całkowity koszt faktury z wyłączeniem podatku VAT. |
|
total_open
|
total_open | string |
Otwarty koszt faktury, w tym VAT. |
|
pdf_url
|
pdf_url | string |
Adres URL do ścieżki pobierania faktury w formacie PDF. |
|
xml_url
|
xml_url | string |
Adres URL do ścieżki pobierania faktury w formacie UML. |
|
cecha
|
feature | string |
Opis faktury wyświetlanej na fakturze. |
|
przypis
|
footnote | string |
Notatka wyświetlana w dolnej części faktury. |
|
invoice_items
|
invoice_items | array of invoice_item | |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
invoice_item
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator elementu faktury. |
|
Units
|
units | number |
Liczba jednostek elementu faktury. |
|
Description
|
name | string |
Nazwa elementu faktury. |
|
Cena
|
unit_price | string |
Cena pojedynczej jednostki. |
|
VAT
|
invoice_vat_id | number |
Identyfikator vat faktury. |
|
Wariant wykazu
|
catalog_variant_id | number |
Identyfikator wariantu wykazu. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
invoice_vat
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy idenitfikator vat faktury. |
|
nazwa
|
name | string |
Nazwa vat faktury. |
|
procent
|
percentage | string |
Liczba reprezentująca wartość procentową podatku VAT. |
catalog_variant
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | number |
Unikatowy identyfikator wariantu wykazu |
|
product_id
|
product_id | number |
Unikatowy identyfikator produktu wykazu |
|
nazwa
|
name | string |
Nazwa kursu. |
|
cost_scheme
|
cost_scheme | string |
Jak wariant wykazu powinien być domyślnie płatny. |
|
koszt
|
cost | string |
Cena do zapłaty za ten wariant wykazu. |
|
waluta
|
currency | string |
Waluta wariantu wykazu. |
|
variantable_type
|
variantable_type | string |
Waluta faktury. |
|
variantable_id
|
variantable_id | number |
Unikatowy identyfikator możliwego do wariantu. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
|
Opublikowany
|
is_published | boolean |
Jeśli kategoria powinna zostać opublikowana w witrynie internetowej. |
etykieta
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | number |
Unikatowy identyfikator etykiety |
|
Name
|
name | string |
Nazwa etykiety. |
|
Kolor
|
color | string |
Kod szesnastkowy koloru etykiety. |
|
Model
|
model_type | string |
Typ modelu, dla którego udostępniono tę etykietę. |
|
updated_at
|
updated_at | string |
Sygnatura czasowa ostatniej aktualizacji. |
|
utworzono_o
|
created_at | string |
Sygnatura czasowa tworzenia. |
webhook_payload
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wychowawca
|
educator | string |
Slug nauczyciela. |
|
wydarzenie
|
event | string |
Typ zdarzenia, które wyzwoliło element webhook. |
|
entity_type
|
entity_type | string |
Typ modelu, który wyzwolił element webhook. |
|
entity_id
|
entity_id | number |
Unikatowy identyfikator modelu, który wyzwolił element webhook. |
|
identyfikator_najemcy
|
tenant_id | string |
UUID nauczyciela. |