Co robi ten punkt końcowy interfejsu API

Za pomocą interfejsu API kursów możesz uzyskać listę wszystkich przesłanych kursów (opublikowanych i niepublikowanych) na swoim koncie Reach 360, a także szczegóły pojedynczego kursu.

• Punkty końcowe
• Obiekt kursu
• Lista kursów
• Pobierz kurs według identyfikatora

Punkty końcowe

• GET /courses- lista kursów
• GET /courses/{courseId}- uzyskać szczegóły kursu według identyfikatora kursu

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, aby pobrać raport kursu z API
• url(string) - URL do pobierania szczegółów kursu z API
• contentType(string) - rodzaj kursu (może być jednym z: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Lista kursów

GET /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)
• contentType(string, opcjonalnie) - Filtruj odpowiedź na określony typ zawartości. Dostępne opcje są rise, storyline, microlearning, imported, all

Przykładowa odpowiedź

{
„courses”: [
{
„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" 
 „contentType”: „RISE”},
... 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Pobierz kurs według identyfikatora

GET /courses/{courseId}

Przykładowa odpowiedź

{
„id”: „example-course-id”, 
 „title”: „Tytuł kursu”, „coverImageURL”: null, 
 „authorUrl”: "https://api.reach360.com/users/author-user-id 
 „, „courseReportUrl”: "https://api.reach360.com/reports/courses/example-course-id „, 
 „url”: "https://api.reach360.com/courses/example-course-id" „contentType”: „RISE”} 
 
 

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

• course_not_found- nie można pobrać kursu, ponieważ kurs nie istnieje