Co robi ten punkt końcowy interfejsu API

Dzięki API ścieżek uczenia się możesz uzyskać listę wszystkich ścieżek uczenia się w Reach 360, a także szczegóły pojedynczej ścieżki uczenia się i kursów, które składają się na ścieżkę uczenia się.

• Punkty końcowe
• Obiekt ścieżki uczenia się
• Ścieżka szkoleniowa Obiekt kursu
• Lista ścieżek edukacyjnych
• Pobierz ścieżkę uczenia się według identyfikatora
• Lista kursów w ścieżce uczenia się

Punkty końcowe

• GET /learning-paths- lista ścieżek uczenia się
• GET /learning-paths/{learningPathId}- uzyskać szczegółowe informacje na temat ścieżki uczenia się poprzez identyfikator ścieżki uczenia się
• GET /learning-paths/{learningPathId}/courses- lista kursów w ścieżce uczenia się według identyfikatora ścieżki uczenia się

Obiekt ścieżki uczenia się

• id(string) - unikalny identyfikator ścieżki uczenia się
• title(string) - tytuł ścieżki uczenia się
• description(string) - opis ścieżki uczenia się
• coverImageUrl(string) - Adres URL obrazu okładki ścieżki edukacyjnej (jeśli istnieje)
• coursesUrl(string) - URL, aby pobrać listę kursów w ścieżce uczenia się z API
• coursesReportUrl(string) - Adres URL do pobrania raportu ścieżki szkoleniowej z interfejsu API
• learnersReportUrl(string) - Adres URL do pobrania raportu ścieżka uczenia się uczestników z interfejsu API
• url(string) - URL, aby pobrać szczegóły ścieżki uczenia się z API

Ścieżka szkoleniowa Obiekt kursu

• id(string) - unikalny identyfikator kursu
• title(string) - tytuł kursu
• coverImageUrl(string) - URL obrazu okładki kursu (jeśli istnieje)
• authorUrl(string) - URL do pobierania danych użytkownika autora z API
• courseReportUrl(string) - URL do pobrania raportu kursu z API
• url(string) - URL do pobierania szczegółów kursu z API
• order(integer) - kolejność kursu w ścieżce uczenia się (numeracja zaczyna się od 0)
• contentType(string) - rodzaj kursu (może być jednym z: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Lista ścieżek edukacyjnych

GET /learning-paths

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 100 (domyślnie 50)

Przykładowa odpowiedź

{
„learningPaths”: [
{
„id”: „example-learning-path-1", „title”: 
 „Tytuł ścieżki edukacyjnej”, „
description”: „Prosta ścieżka uczenia się”, „coverImageURL”: null, „coursesURL”: "https://api.reach360.com/learning-paths/example-learning-path-1/courses 
 „, „coursesReturl”: "https://api.reach360.com/reports/learning-paths/example-learning-path-1/courses 
 „, „learnersReturl”: "https://api.reach360.com/reports/learning-paths/example-learning-path-1/learners, 
 „adres URL”:” 
 
 https://api.reach360.com/learning-paths/example-learning-path-1 "
},... 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 
 

Pobierz ścieżkę uczenia się według identyfikatora

GET /learning-paths/{learningPathId}

Przykładowa odpowiedź

{
„id”: „example-learning-path”, 
 „title”: „Tytuł ścieżki edukacyjnej”, „description”: „Prosta ścieżka uczenia się”, 
 „coverImageUrl”: null, 
 „coursesURL”: "https://api.reach360.com/learning-paths/example-learning-path/courses 
 „, „coursesReportURL”: "https://api.reach360.com/reports/learning-paths/example-learning-path/courses „, „learnersReportURL”: "https://api.reach360.com/reports/learning-paths/example-learning-path/learners 
 „, „url”: "https://api.reach360.com/learning-paths/example-learning-path"} 
 
 

Kody błędów specyficzne dla punktu końcowego

• learning_path_not_found- nie może odzyskać ścieżki uczenia się, ponieważ ścieżka uczenia się nie istnieje

Lista kursów w ścieżce uczenia się

GET /learning-paths/{learningPathId}/courses

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 100 (domyślnie 50)

Przykładowa odpowiedź

{
„learningPathUrl”: "https://api.reach360.com/learning-paths/example-learning-path-id-1 „, „kursy”: [
{
„id”: 
 „example-course-id-1", „title”: 
 „Tytuł kursu”, „coverImageURL”: null, 
 „authorUrl”: "https://api.reach360.com/users/author-user-id „, „courserePortURL”: "https://api.reach360.com/reports/courses/example-course-id-1 
 „, „url”: "https://api.reach360.com/courses/example-course-id-1" 
 „order”: 3 „contentType”: „RISE”},
... 
 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Kody błędów specyficzne dla punktu końcowego

• learning_path_not_found- nie można wymienić kursów, ponieważ ścieżka uczenia się nie istnieje