Cosa fa questo endpoint API

Con l'API Learning Paths puoi ottenere un elenco di tutti i percorsi di apprendimento in Reach 360, nonché i dettagli di un singolo percorso di apprendimento e dei corsi che lo compongono.

• Endpoint
• Oggetto del percorso di apprendimento
• Oggetto del corso Learning Path
• Elenca i percorsi di apprendimento
• Recupera il percorso di apprendimento per ID
• Elenca i corsi in Learning Path

Endpoint

• GET /learning-paths- elenca i percorsi di apprendimento
• GET /learning-paths/{learningPathId}- ottieni i dettagli di un percorso di apprendimento tramite l'ID del percorso di apprendimento
• GET /learning-paths/{learningPathId}/courses- elenca i corsi in un percorso di apprendimento in base all'ID del percorso di apprendimento

Oggetto del percorso di apprendimento

• id(stringa) - l'identificatore univoco del percorso di apprendimento
• title(stringa) - titolo del percorso di apprendimento
• description(stringa) - descrizione del percorso di apprendimento
• coverImageUrl(stringa) - URL per l'immagine di copertina del percorso di apprendimento (se presente)
• coursesUrl(string) - URL per recuperare l'elenco dei corsi nel percorso di apprendimento dall'API
• coursesReportUrl(stringa) - URL per recuperare il rapporto sui corsi del percorso di apprendimento dall'API
• learnersReportUrl(string) - URL per recuperare il percorso di apprendimento segnalato dagli allievi dall'API
• url(stringa) - URL per recuperare i dettagli del percorso di apprendimento dall'API

Oggetto del corso Learning Path

• 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
• order(intero) - ordine di un corso in un percorso di apprendimento (la numerazione inizia da 0)
• contentType(stringa) - tipo di corso (può essere uno dei seguenti: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Elenca i percorsi di apprendimento

GET /learning-paths

Parametri della 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)

Esempio di risposta

{
«learningPaths»: [
{
«id»: «example-learning-path-1", «title»: 
 «Titolo del percorso di apprendimento», «
description»: «Un percorso di apprendimento semplice», «coverImageURL»: null, «coursesUrl»: "https://api.reach360.com/learning-paths/example-learning-path-1/courses 
 «, «coursesReportUrl»: "https://api.reach360.com/reports/learning-paths/example-learning-path-1/courses 
 «, «learnersReportURL»: "https://api.reach360.com/reports/learning-paths/example-learning-path-1/learners 
 «, «url»:» 
 
 https://api.reach360.com/learning-paths/example-learning-path-1 "
},... 
], 
 «nextURL»: "https://url-for-next-page-of-results"} 
 

Recupera il percorso di apprendimento per ID

GET /learning-paths/{learningPathId}

Esempio di risposta

{
«id»: «example-learning-path», 
 «title»: «Learning Path Title», «description»: «Un percorso di apprendimento semplice», 
 «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"} 
 

Codici di errore specifici dell'endpoint

• learning_path_not_found- impossibile recuperare il percorso di apprendimento perché il percorso di apprendimento non esiste

Elenca i corsi nel percorso di apprendimento

GET /learning-paths/{learningPathId}/courses

Parametri della 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)

Esempio di risposta

{
«learningPathUrl»: "https://api.reach360.com/learning-paths/example-learning-path-id-1 «, 
 «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" 
 «order»: 3 «contentType»: «RISE»},
... 
 
 
 
], 
 «nextUrl»: "https://url-for-next-page-of-results"
}

Codici di errore specifici dell'endpoint

• learning_path_not_found- non è possibile elencare i corsi perché il percorso di apprendimento non esiste