Cosa fa questo endpoint API

Con l'API Courses puoi ottenere un elenco di tutti i corsi inviati (pubblicati e inediti) nel tuo account Reach 360, nonché i dettagli di un singolo corso.

• Endpoint
• Oggetto del corso
• Elenca corsi
• Recupera il corso per ID

Endpoint

• GET /courses- elenca i corsi
• GET /courses/{courseId}- ottenere i dettagli di un corso in base all'ID del corso

Oggetto del corso

• id(stringa) - l'identificatore univoco del corso
• title(stringa) - titolo del corso
• coverImageUrl(stringa) - URL per l'immagine di copertina del corso (se presente)
• authorUrl(string) - URL per recuperare i dettagli dell'utente dell'autore dall'API
• courseReportUrl(string) - URL per recuperare il rapporto sul corso dall'API
• url(string) - URL per recuperare i dettagli del corso dall'API
• contentType(stringa) - tipo di corso (può essere uno dei seguenti: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Elenca i corsi

GET /courses

Parametri di richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 100 (il valore predefinito è 50)
• contentType(stringa, opzionale): filtra la risposta a un tipo di contenuto specifico. Le opzioni disponibili sono rise, storyline, microlearning, imported, all

Esempio di risposta

{
«courses»: [
{
«id»: «example-course-id-1", «title»: 
 «Titolo del corso», «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"} 
 

Recupera il corso per ID

GET /courses/{courseId}

Esempio di risposta

{
«id»: «example-course-id», 
 «title»: «Titolo del corso», «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»} 
 
 

Codici di errore specifici dell'endpoint

• course_not_found- impossibile recuperare il corso perché il corso non esiste