API
curlNodePythonJavaRubyphpGo
API ClassOnlive
  • Se desideri usare l'API di classonlive, avrai bisogno di un TOKEN

  • Per ottenere il token, naviga al tuo pannello di controllo di classonlive.com, vai alla sezione delle integrazioni e fai clic sulla scheda API. Una volta lì dovrai registrare l'IP da cui verranno effettuate le richieste. All'IP verrà associato un token simile a: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjbGFzc29ubGl2ZSIsI.mRhdGEiOiJ7XC Devi cambiare la parte di {TOKEN} nei percorsi, con il token associato al tuo IP. Potrai effettuare richieste solo dall'IP che hai registrato.

  • Questa API è progettata per creare webinar / conferenze dal vivo / lezioni in diretta. Queste lezioni in questa documentazione saranno chiamate “content”.

  • Questa API non funziona con corsi modulari o di pacchetto.

Content
Content Generale

ContentObject è l'oggetto che viene restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sul corso in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Response Body” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto Content Generale
Attributes
  • contentId
    numberRequired
    Identificatore usato per cancellare/modificare il content
  • title
    stringRequired
    Titolo/nome del content
  • teacher
    stringRequired
    Email del professore
  • type
    objectRequired
    Restituisce una Stringa con il tipo di videoconferenza da creare
    Espandi attributiChiudi attributi
    • Broadcast
      string
      1 insegnante, fino a 150 partecipanti
    • Molti_a_Molti
      string
      1 insegnante, fino a 9 partecipanti con audio/video
    • Uno_a_Uno
      string
      1 insegnante, 1 partecipante con audio/video
  • oneDayDate
    stringOptional
    Data trasformata in String con la data dell'unica sessione dal vivo, vuota se il contenuto è di tipo contentDay
  • multipleDayFromDate
    stringOptional
    Data trasformata in String con la data di inizio del corso, vuota se il contenuto è di un solo giorno
  • multipleDayToDate
    stringOptional
    Data trasformata in String con la data di fine del corso, vuota se il contenuto è di un solo giorno
  • particularInitDate
    stringOptional
    Data trasformata in String con la data di inizio del corso particolare, vuota se il contenuto è di un solo giorno
  • particularEndDate
    stringOptional
    Data trasformata in String con la data di fine del corso particolare, vuota se il contenuto è di un solo giorno
  • contentType
    objectRequired
    Restituisce una String con il tipo di contenuto creato
    Espandi attributiChiudi attributi
    • oneDay
      string
      Contenuto con una sessione dal vivo di 1 giorno
    • multipleDay
      string
      Contenuto con più sessioni dal vivo in giorni diversi
    • particular
      string
      Contenuto di tipo lezione privata
  • scormPath
    stringOptional
    Restituisce il link del contenuto di tipo Scorm se è un corso di tipo Scorm
Crea un contenuto
Parametri Url
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Temi
    'Misura','Modulare','Temi','Particolare','Pacchetto' Tipo di corso.
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/content
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "Titulo de ejemplo",
    "type": "Argomenti"
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/content \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "contentId": 33078
}
Modifica un contenuto
Parametri Url
  • token
    string
  • contentId
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Temi
    'Misura','Temi','Particolare','Pacchetto' Tipo di corso.
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "Titulo de ejemplo",
    "type": "Argomenti"
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid} \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "contentId": 33078
}
Elenca tutti i contenuti
Parametri URL
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/content
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "contentList": [
    {
        "contentId": 32957,
        "title": "Ejemplo curso un día",
        "teacher": "[email protected]",
        "oneDayDate": "2020-10-28T22:12:00.000Z",
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "oneDay",
        "scormPath" : "enlace_curso_scorm"
    },
    {
        "contentId": 32956,
        "title": "Ejemplo curso multisesión",
        "teacher": "[email protected]",
        "oneDayDate": null,
        "multipleDayFromDate": "2020-07-23T22:00:00.000Z",
        "multipleDayToDate": "2020-08-24T22:00:00.000Z",
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "multipleDay",
        "scormPath" : "enlace_curso_scorm"
    },
    {
        "contentId": 32953,
        "title": "Ejemplo curso particular",
        "teacher": null,
        "oneDayDate": null,
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "particular",
        "scormPath" : "enlace_curso_scorm"
    }
],
"ok": true
}
Richiedere dati di un contenuto
Parametri URL
  • contentId
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
//si es de sesión única
{
    "content": {
        "contentId": 32960,
        "title": "título curso única sesión",
        "teacher": "[email protected]",
        "oneDayDate": "2020-10-28T22:12:00.000Z",
        "durartion": "d30m",
        "type": "Broadcast"
    },
    "ok": true
}
//si es multisesión
{
    "content": {
        "contentId": 32962,
        "title": "título curso multisesión",
        "teacher": "[email protected]",
        "multipleDayFromDate": "2020-07-23T22:00:00.000Z",
        "multipleDayToDate": "2020-08-24T22:00:00.000Z",
        "type": "Broadcast",
        "dates": [
            "2020-08-20T05:30:00.000Z",
            "2020-08-13T05:30:00.000Z",
            "2020-08-06T05:30:00.000Z",
            ...
        ]
    },
    "ok": true
}
//si es particular
{
    "content": {
        "contentId": 32953,
        "title": "título de curso particular",
        "startDate": null,
        "endDate": null,
        "type": "Broadcast",
        "contentType": "Particolare"
    },
    "ok": true
}
// si es scorm 
{
    "content": {
        "contentId": 3812,
        "title": "Curso Scorm",
        "startDate": null,
        "endDate": null,
        "type": null,
        "contentType": "Scorm",
        "scormPath": "enlace_curso_scorm"
    },
    "ok": true
}
Elimina contenuto
Parametri URL
  • contentId
    string
  • token
    string
Definition
DELETE https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}
Request
Esempio di richiesta
curl --request DELETE \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
"ok": true
}
Cambia il professore di un contenuto (multisessione o sessione unica)
Parametri URL
  • contentId
    string
  • token
    string
Attributes
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/insegnante
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "teacher": "[email protected]"
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/teacher \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true
}
Cerca contenuto per titolo
Parametri URL
  • search
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/contenuto/cerca/{cerca}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content/search/{search}
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
"contentList": [
    {
        "contentId": 32957,
        "title": "Ejemplo curso un día",
        "teacher": "[email protected]",
        "oneDayDate": "2020-10-28T22:12:00.000Z",
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "oneDay"
    },
    {
        "contentId": 32956,
        "title": "Ejemplo curso multisesión",
        "teacher": "[email protected]",
        "oneDayDate": null,
        "multipleDayFromDate": "2020-07-23T22:00:00.000Z",
        "multipleDayToDate": "2020-08-24T22:00:00.000Z",
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "multipleDay"
    },
    {
        "contentId": 32953,
        "title": "Ejemplo curso particular",
        "teacher": null,
        "oneDayDate": null,
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "particular"
    }
],
"ok": true
}
Modifica il titolo di un contenuto
Parametri URL
  • contentId
    string
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/contenuto/{contentid}/titolo
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "nuevo título"
}

Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/title \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true
}
Contenuto Sessione Unica

ContentSingleSessionObject è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sul corso in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto Contenuto Sessione Unica
Attributes
  • contentId
    numberRequired
    Identificatore utilizzato per eliminare/modificare il contenuto
  • teacherLink
    objectRequired
    Oggetto con link alla sala di videoconferenza
    Espandi attributiChiudi attributi
    • ok
      booleanRequired
      Restituisce true se non si è verificato alcun errore durante la creazione della sessione, altrimenti restituisce false
    • link
      stringRequired
      Link alla sala di videoconferenza
    • name
      stringRequired
      Nome del professore
    • teacher
      stringRequired
      Email del professore
  • ok
    booleanRequired
    Restituisce true se non si è verificato alcun errore, altrimenti restituisce false
Crea un contenuto di sessione unica
Parametri URL
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 professore, fino a 150 partecipanti, 'Many_to_Many' 1 professore, fino a 9 partecipanti con audio/video, 'One_to_One' 1 professore, 1 partecipante con audio/video
  • duration
    stringRequired
    Esempio: d30m
    'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • session
    string
    Esempio: 2020
    10-28T22:12:00.000Z (stringa, obbligatoria) - Data con formato yyyy-MM-dd'T'HH:mm:ss.SSS'Z', accetta anche date in millisecondi dal 1970 es: 1573035966995
  • teacher
    stringRequired
    Email del professore
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/content/oneDay
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "Titulo de ejemplo",
    "session": "2020-10-28T22:12:00.000Z",
    "teacher": "[email protected]",
    "type": "Broadcast",
    "duration": "d30m"
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/content/oneDay \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "contentId": 32960,
    "teacherLink": {
        "link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=ye4ll60UOoahUykx/ZhY9A==",
        "name": "teacher name",
        "email": "[email protected]",
        "ok": true
    },
    "ok": true
}
Cambia la sessione di un contenuto di sessione unica
Parametri URL
  • contentId
    string
  • token
    string
Attributes
  • duration
    stringRequired
    Esempio: d30m
    'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • date
    string
    Esempio: 2020
    10-28T22:12:00.000Z (stringa, obbligatoria) - Data con formato yyyy-MM-dd'T'HH:mm:ss.SSS'Z', accetta anche date in millisecondi dal 1970 es: 1573035966995
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/session
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "date": "2020-10-28T22:12:00.000Z",
    "duration": "d30m"
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/session \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true
}
Contenuto Sessione Multipla

L'oggetto Contenuto Sessione Multipla è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sul corso in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto della sessione multipla di contenuto
Attributes
  • contentId
    numberRequired
    Esempio: 32966
    Identificatore della sessione multipla di contenuto
  • ok
    booleanRequired
    Restituisce true se non si è verificato alcun errore nella creazione della sessione multipla, altrimenti restituisce false
Crea un contenuto di sessione multipla
Parametri URL
  • contentId
    string
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 insegnante, fino a 150 partecipanti, 'Many_to_Many' 1 insegnante, fino a 9 partecipanti con audio/video, 'One_to_One' 1 insegnante, 1 partecipante con audio/video
  • teacher
    stringRequired
    Email dell'insegnante
  • startDate
    stringRequired
    Esempio: 2019-11-20
    Data nel formato YYYY-MM-DD
  • endDate
    stringRequired
    Esempio: 2019-11-20
    Data nel formato YYYY-MM-DD
  • monday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • tuesday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • wednesday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • thursday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • friday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • saturday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • sunday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "Título de ejemplo",
    "startDate": "2020-10-28T22:12:00.000Z",
    "endDate": "2020-11-28T22:12:00.000Z",
    "type": "Broadcast",
    "teacher":"[email protected]",
    "wednesday": {
        "hour":"02",
        "minutes":"30",
        "duration":"d15h"
        },
    "tuesday": {
        "hour":"02",
        "minutes":"30",
        "duration":"d15h"
        }
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "contentId": 32966,
    "ok": true
}
Cambia la sessione di un contenuto di sessione multipla
Parametri URL
  • contentId
    string
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 insegnante, fino a 150 partecipanti, 'Many_to_Many' 1 insegnante, fino a 9 partecipanti con audio/video, 'One_to_One' 1 insegnante, 1 partecipante con audio/video
  • teacher
    stringRequired
    Email dell'insegnante
  • startDate
    stringRequired
    Esempio: 2019-11-20
    Data in formato YYYY-MM-DD
  • endDate
    stringRequired
    Esempio: 2019-11-20
    Data in formato YYYY-MM-DD
  • monday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • tuesday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • wednesday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • thursday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • friday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • saturday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minutes (Sólo acepta 0, 15, 30, 45)
    • duration
      stringRequired
      Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
  • sunday
    object
    Objeto con propiedades
    Expand attributesClose attributes
    • hour
      stringRequired
      hora en GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "startDate": "2020-10-28T22:12:00.000Z",
    "endDate": "2020-11-28T22:12:00.000Z",
    "type": "Broadcast",
    "teacher":"[email protected]",
    "wednesday": {
        "hour":"02",
        "minutes":"30",
        "duration":"d15h"
        }
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "contentId": 32966,
    "ok": true
}
Pack

Il tipo di contenuto pack è un contenuto che racchiude più contenuti.

Aggiungi contenuti a un pacchetto
Parametri URL
  • token
    string
  • contentId
    string
Attributes
  • selectedContents
    arrayRequired
    array di numeri, ogni numero deve corrispondere a un contentId di un contenuto di tipo 'Misura' o 'Drip'
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/content/{contentId}/packContents
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
   "selectedContents": [33057, 33054]
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentId}/packContents \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    ok: true
}
Particolare

ParticolareObject è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sul corso in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto particolare
Attributes
  • contentId
    numberRequired
    Identificatore utilizzato per eliminare/modificare il contenuto
  • sessions
    objectRequired
    Array di oggetti sessione
    Espandi attributiChiudi attributi
    • sessionId
      numberRequired
      identificatore della sessione
    • teacher
      stringRequired
      Email del docente
    • date
      stringRequired
      Data della sessione
    • teacherLink
      stringRequired
      Link di accesso alla sessione per il docente
    • applicants
      objectRequired
      Array di oggetti studente
      Espandi attributiChiudi attributi
      • applicantId
        numberRequired
        identificatore dello studente
      • email
        stringRequired
        Email dello studente
      • name
        stringRequired
        Nome dello studente
      • link
        stringRequired
        Link di accesso alla sessione per lo studente
  • ok
    booleanRequired
    Restituisce true se non si è verificato alcun errore, altrimenti restituisce false
  • type
    objectRequired
    Restituisce una Stringa con il tipo di videoconferenza da creare
    Espandi attributiChiudi attributi
    • Broadcast
      string
      1 insegnante, fino a 150 partecipanti
    • Molti_a_Molti
      string
      1 insegnante, fino a 9 partecipanti con audio/video
    • Uno_a_Uno
      string
      1 insegnante, 1 partecipante con audio/video
Crea un contenuto particolare
Parametri Url
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 insegnante, fino a 150 partecipanti, 'Molti_a_Molti' 1 insegnante, fino a 9 partecipanti con audio/video, 'Uno_a_Uno' 1 insegnante, 1 partecipante con audio/video
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/content/particular
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "particular desde API",
    "type": "Broadcast"
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/content/particular \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "contentId": 32961
}
Modifica un contenuto particolare
Parametri Url
  • contentId
    string
  • token
    string
Attributes
  • title
    stringRequired
    Esempio: Titolo di esempio
    Titolo del corso
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 insegnante, fino a 150 partecipanti, 'Molti_a_Molti' 1 insegnante, fino a 9 partecipanti con audio/video, 'Uno_a_Uno' 1 insegnante, 1 partecipante con audio/video
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/content/particular/{contentId}
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title": "particular desde API",
    "type": "Broadcast"
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/content/particular/{contentId} \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "contentId": 32961
}
aggiungere/modificare il calendario di un contenuto particolare
Parametri URL
  • contentId
    string
  • token
    string
Attributes
  • startDate
    stringRequired
    Esempio: 2019-11-20
    Data nel formato YYYY-MM-DD
  • endDate
    stringRequired
    Esempio: 2019-11-20
    Data nel formato YYYY-MM-DD
  • sessions
    arrayRequired
    Esempio: [oggetto Oggetto]
    Ogni oggetto deve avere una proprietà teacher con l'email dell'insegnante e una proprietà per giorno della settimana (almeno un giorno è richiesto), con il nome del giorno in inglese, con un array delle ore nel formato HH:00 con l'ora corrispondente al fuso orario GMT
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/particolare/{contentid}/calendario
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "startDate": "2019-11-20",
    "endDate": "2020-01-20",
    "sessions": [
        {
            "teacher":"[email protected]",
            "monday": ["12:00", "14:00"],
            "tuesday": ["13:00"]
        }
    ]
}
Richiesta di esempio
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/particular/{contentid}/calendar \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "contentId": "32951",
    "ok": true
}
Richiedere il calendario di un contenuto particolare
Parametri URL
  • contentId
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/particolare/{contentid}/calendario
Request
Richiesta di esempio
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/particular/{contentid}/calendar
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
    {
        "contentId": "32951",
        "sessions": [
            {
                "sessionId": 85262,
                "teacher": "[email protected]",
                "date": "2019-11-25T12:00:00.000Z",
                "teacherLink": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=//TiEr+Mz1AYTxk1JwViRA==&claseParticolareId=85262",
                "applicants": [
                    {
                        "applicantId": 142819,
                        "email": "[email protected]",
                        "name": "pepa",
                        "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=goNzUM32KTAc/53SbBQhLA==&claseParticolareId=85262"
                    },
                    {
                        "applicantId": 142826,
                        "email": "[email protected]",
                        "name": "pepa",
                        "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=g8FK3/hKIHVHaAqRZWrjZA==&claseParticolareId=85262"
                    }
                ]
            },
            {
                "sessionId": 85263,
                "teacher": "[email protected]",
                "date": "2019-11-25T14:00:00.000Z",
                "teacherLink": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=//TiEr+Mz1AYTxk1JwViRA==&claseParticolareId=85263",
                "applicants": [
                    {
                        "applicantId": 142826,
                        "email": "[email protected]",
                        "name": "pepa",
                        "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=g8FK3/hKIHVHaAqRZWrjZA==&claseParticolareId=85263"
                    }
                ]
            }
        ],
        "ok": true,
        "type": "One_to_One"
    }

Argomenti

ThemeObject è l'oggetto restituito quando si effettua una richiesta per un tema.

Oggetto Temi
Attributes
  • themeId
    numberRequired
    Identificatore utilizzato per eliminare/modificare il tema
  • title
    stringRequired
    Titolo/nome del tema
  • description
    stringOptional
    Descrizione del tema
Aggiungere un tema a un corso
Parametri URL
  • token
    string
Attributes
  • contentId
    numberRequired
    Identificatore del contenuto
  • title
    stringRequired
    Titolo/nome del tema
  • description
    stringRequired
    Descrizione del tema
  • order
    numberRequired
    Numero utilizzato per ordinare i temi.
  • themeId
    number
    Identificatore del tema nel caso si voglia modificare un tema. Per creare un nuovo tema lasciare vuoto.
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/theme
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title":"Título del tema"
    "description":"Descripción del tema"
    "contentId":33079
    "order":1
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/theme \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "themeId": 38
}
Aggiungi un modulo a un tema
Parametri URL
  • token
    string
Attributes
  • contentId
    numberRequired
    Identificatore del contenuto
  • title
    stringRequired
    Titolo/nome del modulo
  • description
    stringRequired
    Descrizione del modulo
  • order
    numberRequired
    Numero utilizzato per ordinare i temi.
  • themeId
    numberRequired
    Identificatore del tema a cui si aggiungerà il modulo.
  • moduleId
    number
    Identificatore del modulo nel caso si voglia modificare un modulo. Per creare un nuovo modulo lasciare vuoto.
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/theme/addModule
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "title":"Título del módulo"
    "description":"Descripción del módulo"
    "contentId":33079,
    "themeId": 38,
    "order":1
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/theme/addModule \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "moduleId": 38
}
Aggiungi una sessione unica a un modulo
Parametri URL
  • token
    string
Attributes
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 insegnante, fino a 150 partecipanti, 'Many_to_Many' 1 insegnante, fino a 9 partecipanti con audio/video, 'One_to_One' 1 insegnante, 1 partecipante con audio/video
  • duration
    stringRequired
    Esempio: d30m
    'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • startDay
    string
    Esempio: 2020
    10-28T22:12:00.000Z (stringa, obbligatoria) - Data con formato yyyy-MM-dd'T'HH:mm:ss.SSS'Z', accetta anche date in millisecondi dal 1970 es: 1573035966995
  • teacher
    stringRequired
    Email dell'insegnante
  • moduleId
    number
    Identificatore del modulo.
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/theme/setOneDaySession
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "duration":"d15h",
    "moduleId":11789,
    "startDay":1622373300000,
    "teacher":"[email protected]",
    "type":"Broadcast"
}
Richiesta di esempio
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/theme/setOneDaySession \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    ok: true,
    resourceId: 32425
}
Aggiungi una sessione unica a un modulo
Parametri URL
  • token
    string
Attributes
  • type
    stringRequired
    Esempio: Broadcast
    'Broadcast' 1 insegnante, fino a 150 partecipanti, 'Many_to_Many' 1 insegnante, fino a 9 partecipanti con audio/video, 'One_to_One' 1 insegnante, 1 partecipante con audio/video
  • teacher
    stringRequired
    Email dell'insegnante
  • startDate
    stringRequired
    Esempio: 2019-11-20
    Data nel formato YYYY-MM-DD o millisecondi dal 1970
  • endDate
    stringRequired
    Esempio: 2019-11-20
    Data nel formato YYYY-MM-DD o millisecondi dal 1970
  • monday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • tuesday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • wednesday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • thursday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT con formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore
  • friday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • saturday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore`
  • sunday
    object
    Oggetto con proprietà
    Espandi attributiChiudi attributi
    • hour
      stringRequired
      ora in GMT nel formato HH
    • minutes
      stringRequired
      minuti (Accetta solo 0, 15, 30, 45)
    • duration
      stringRequired
      Accetta solo: 'd30m' 30 min, 'd1h' 1 ora, 'd15h' 1h 30m, 'd2h' 2 ore, 'd3h' 3 ore, 'd4h' 4 ore, 'd5h' 5 ore, 'd6h' 6 ore, 'd7h' 7 ore, 'd8h' 8 ore'
  • moduleId
    number
    Identificatore del modulo.
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/theme/setMultipleDaySession
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "moduleId":11788,
    "startDate":1621591200000,
    "teacher":"[email protected]",
    "endDate":1624096800000,
    "type":"Broadcast",
    "thursday": {"duration":"d5h", "minutes": "30", "hour": "11"},
    "tuesday": {"duration": "d6h", "minutes": "30", "hour": "14"}
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/theme/setMultipleDaySession \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    ok: true,
    resourceId: 32425
}
Richiedere i moduli di un tema
Parametri URL
  • token
    string
  • themeId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/theme/getThemeModules/{themeId}
Request
Intestazioni della richiesta
Content-Type: application/json
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/theme/getThemeModules/{themeId} \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "modules": {
        134: {
            moduleId: 134,
            title: "Título del módulo",
            description: "Descripción del módulo",
            order: 1
        },
        ...
    }
}
Richiedere i contenuti di un modulo
Parametri URL
  • token
    string
  • themeId
    string
Attributes
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/theme/getModule/{moduleId}
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
  "email": "[email protected]"
}
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/theme/getModule/{moduleId} \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "module": [
        {
            'resourceType': 'Session',
            'resourceId': 324234,
            "initOneDayDate": null,
            "initMidLongDate": '2020-10-28T22:12:00.000Z',
            "endMidLongDate": '2020-10-28T22:12:00.000Z',
            "theContentDuration": 'd1h',
            "theContentMethod": 'Broadcast',
            "theContentType": 'Mid-Long',
            "theAssignedExpert": '[email protected]',
        },
        {
            'resourceType': 'Video'
            "resourceId": 2342,
            "title": 'título',
            "description": 'descripción'
        },
        {
            'resourceType': 'Resource',
            "resourceId": 34523,
            "title": 'título',
            "description": 'descripción'
        }
    ]
}
Risorse di contenuto
Risorsa generale

La risorsa è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni sulla risorsa in questione. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto risorsa generale
Attributes
  • resourceType
    stringRequired
    Tipo di risorsa - ["Video","Risorsa",("Sessione" Solo se il contenuto è di tipo temi)]
  • title
    stringRequired
    Titolo/nome della risorsa
  • description
    stringRequired
    Descrizione della risorsa
  • resourceId
    numberRequired
    Identificatore della risorsa
Ricevere risorse da un corso
Parametri URL
  • token
    string
  • contentId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/content/getresources/{contentId}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content/getresources/{contentId}
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "courseTitle": "Titulo del curso",
    "external": null,
    "creator": 13653,
    "courseType": null,
    "own": [],
    "resources": [
        {
            "resourceType": "Video",
            "title": "vídeo nuevo",
            "description": "Esta es la descripción del vídeo",
            "resourceId": 285095
        },
        {
            "resourceType": "Resource",
            "title": "Título del recurso",
            "description": "Esta es la descripción del documento",
            "resourceId": 380443
        },...
    ],
    "contentIdentifier": "titulo-del-curo",
    "ok": true
}
Ricevere il link di una risorsa

Questa richiesta restituirà un link di accesso alla risorsa in questione. Il parametro resourceType accetta solo le stringhe (“Video”, “Risorsa”).

Parametri URL
  • token
    string
  • resourceType
    string
  • resourceId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/content/getresourcelink/{resourceType}/{resourceId}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content/getresourcelink/{resourceType}/{resourceId}
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "link": "https://www.example.com/archivo.pdf"
}
Risorse temi/moduli

La risorsa è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni sulla risorsa in questione. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto risorse temi/moduli
Attributes
  • resourceType
    stringRequired
    Tipo di risorsa - ["Video","Risorsa",("Session" Solo se il contenuto è di tipo temi)]
  • title
    stringRequired
    Titolo/nome della risorsa
  • description
    stringRequired
    Descrizione della risorsa
  • resourceId
    numberRequired
    Identificatore della risorsa
Ricevere risorse da un modulo
Parametri Url
  • token
    string
  • moduleId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/theme/getmoduleresources/{moduleId}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/theme/getmoduleresources/{moduleId}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "courseTitle": "Titulo del curso",
    "external": null,
    "creator": 13653,
    "courseType": null,
    "own": [],
    "resources": [
        {
            "resourceType": "Video",
            "title": "vídeo nuevo",
            "description": "Esta es la descripción del vídeo",
            "resourceId": 285095
        },
        {
            "resourceType": "Resource",
            "title": "Título del recurso",
            "description": "Esta es la descripción del documento",
            "resourceId": 380443
        },
        {
            "resourceType": "Session",
            "resourceId": 614091,
            "initOneDayDate": 1621404000000,
            "initMidLongDate": null,
            "endMidLongDate": null,
            "theContentDuration": "d30m",
            "theContentMethod": "Broadcast",
            "theContentType": "One_Day",
            "theAssignedExpert": "[email protected]"
        },...
    ],
    "contentIdentifier": "titulo-del-curo",
    "ok": true
}
Ricevere il link di una risorsa da un modulo

Questa richiesta restituirà un link di accesso alla risorsa in questione. Il parametro resourceType accetta solo le stringhe (“Video”, “Risorsa”, “Session”).

Parametri Url
  • token
    string
  • resourceType
    string
  • resourceId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/content/getmoduleresourcelink/{resourceType}/{resourceId}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content/getmoduleresourcelink/{resourceType}/{resourceId}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "link": "https://www.example.com/archivo.pdf"
}
VideoRecords
videoRecords

VideoRecords è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sul video in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto VideoRecords
Attributes
  • id
    numberRequired
    Identificatore utilizzato per fare riferimento al video
  • driveUrl
    stringRequired
    Link del video su Google Drive
  • downloadLink
    stringRequired
    Link del video per il download
  • users
    objectRequired
    Array di utenti che hanno accesso al video, se non è condiviso con alcuno studente restituisce un array vuoto
    Espandi attributiChiudi attributi
    • canDownload
      booleanRequired
      Restituisce true se il richiedente ha il permesso di scaricare il video
    • applicantId
      numberRequired
      Identificatore del richiedente
    • viewLink
      stringRequired
      Link per visualizzare il video
    • email
      stringRequired
      Email del richiedente
    • name
      stringRequired
      Nome assegnato al richiedente
  • processed
    booleanRequired
    Lo stato del video. True se è stato elaborato, false se non è ancora disponibile
  • title
    stringOptional
    Titolo del video. Se non ha titolo restituisce il campo vuoto
  • moduleId
    numberOptional
    Identificatore del modulo se il video appartiene a un corso modulare, altrimenti restituisce il campo vuoto
  • registerDate
    stringRequired
    La data in cui la registrazione è stata aggiunta al corso in formato String
  • order
    numberOptional
    Ordine del video da mostrare
  • filename
    stringRequired
    Data trasformata in String con la data di fine del corso particolare, vuoto se il contenuto è di un solo giorno
  • downloaded
    booleanRequired
    Restituisce true se è consentito scaricare il video, altrimenti restituisce false
  • published
    booleanRequired
    Restituisce true se il video è pubblicato e accessibile, altrimenti restituisce false
  • userLinks
    objectOptional
    (SOLO quando si richiedono le registrazioni di un applicant). Oggetto con i link di visualizzazione e download per quell'applicant
    Espandi attributiChiudi attributi
    • canDownload
      booleanRequired
      Restituisce true se l'applicant ha il permesso di scaricare il video
    • applicantId
      numberRequired
      Identificatore dell'applicant,
    • viewLink
      stringRequired
      Link per visualizzare il video
  • ok
    booleanRequired
    Restituisce true se non si è verificato alcun errore, altrimenti restituisce false
Richiedere le registrazioni di un contenuto
Parametri Url
  • token
    string
  • contentId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "videos": [
        {
            "driveUrl": null,
            "id": 81583,
            "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4",
            "users": [
                {
                    "canDownload": true,
                    "email": "[email protected]",
                    "name": "example",
                    "applicantId": 644,
                    "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&3&Z1e3YzxFffxA5Z385h58/w=="
                }
                ...
            ],
            "processed": true,
            "title": null,
            "moduleId": null,
            "order": 1,
            "registerDate": "2019-11-04",
            "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
            "downloaded": false,
            "published": false
        },
        {
            "driveUrl": null,
            "id": 81584,
            "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54151/IntercoachGroup21552475760317/IntercoachGroup21552475760317.m3u8",
            "users": [
                {
                    "canDownload": true,
                    "email": "[email protected]",
                    "name": "example",
                    "applicantId": 644,
                    "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&3&Z1e3YzxFffxA5Z385h58/w=="
                }
                ...
            ],
            "processed": true,
            "title": null,
            "moduleId": null,
            "order": 1,
            "registerDate": "2019-11-04",
            "filename": "IntercoachGroup21552475760317/IntercoachGroup21552475760317.m3u8",
            "downloaded": false,
            "published": false
        },
        ...
    ],
    "ok": true
}

Richiedere le registrazioni di un applicant
Parametri Url
  • contentId
    string
  • token
    string
  • applicantId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}/{applicantId}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}/{applicantId}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "videos": [
        {
            "driveUrl": null,
            "id": 81583,
            "processed": true,
            "title": null,
            "moduleId": null,
            "order": 1,
            "registerDate": "2019-11-04",
            "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
            "userLinks": {
                "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4", // Enlace del vídeo para descargar
                "canDownload": true, // Devuelve true si el applicant tiene permitido la descarga del vídeo
                "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&81583&BctkcZnlr+GUfIDab42L/g==" // Enalce para visualizar el vídeo
            },
            "downloaded": true,
            "published": true
        }
    ],
    "ok": true
}

Condividere un video con uno studente
Parametri Url
  • token
    string
Attributes
  • videoId
    numberRequired
    Esempio: 50
    Identificatore del video
  • appList
    objectRequired
    Array di oggetti che contengono gli applicants con cui si desidera condividere un video
    Espandi attributiChiudi attributi
    • applicantId
      numberRequired
      Esempio: 1938
      Identificatore dell'applicant con cui si desidera condividere il video
    • downloadable
      booleanOptional
      Vero se desideri che l'applicant possa scaricare anche il video
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/video_records/publishvideo
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "videoId": 50,
    "appList": [{
        "applicantId": 1938, // Identificador del applicant
        "downloadable": true // True para permitir applicant la descarga del vídeo
    },
    {
        "applicantId": 1937,
        "downloadable": true
    }]

}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/video_records/publishvideo \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "video": {
        "driveUrl": null,
        "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4",
        "title": null,
        "processed": true,
        "donwloaded": false,
        "moduleId": null,
        "order": 1,
        "registerDate": "2019-11-04",
        "videoId": 81583,
        "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
        "published": false,
        "users": [
            {
                "canDownload": true, // Devuelve true si el applicant tiene permitido la descarga del vídeo
                "applicantId": 142836, // Identificador del applicant
                "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&81583&L80POO/O9RX1z3Wle242xg==" // Enalce para visualizar el vídeo
            },
            ...
        ]
    }
}
Dispubblicare un video per uno studente
Parametri URL
  • token
    string
Attributes
  • videoId
    stringRequired
    Esempio: 81233
    L'identificatore del video
  • appList
    objectRequired
    Array con identificatori degli studenti (applicantId)
    Espandi attributiChiudi attributi
    • applicantId
      stringRequired
      Identificatore dell'applicant
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/video_records/unpublishvideo
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
"videoId": 81583,
    "appList": [
        142836,
        ...
    ]
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/video_records/unpublishvideo \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "video": {
        "driveUrl": null,
        "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4",
        "title": null,
        "processed": true,
        "donwloaded": true,
        "moduleId": null,
        "order": 1,
        "registerDate": "2019-11-04",
        "videoId": 81583,
        "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
        "published": true
    }
}
Utenti
Utenti Generali

ApplicantObject è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sull'utente in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto Utenti Generali
Attributes
  • name
    string
    Il nome utente
  • newEmail
    string
    La nuova email in caso di cambio email
  • ok
    booleanRequired
    Restituisce true se non si è verificato alcun errore, altrimenti restituisce false
Richiedere il nome di un utente
Parametri URL
  • email
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/username/{email}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/username/{email}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "name": "nombre",
    "ok": true
}
Modificare il nome di un utente
Parametri URL
  • email
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/username/{email}
Request
Intestazioni di richiesta
Content-Type: application/json
Corpo della richiesta
{
    "email": "[email protected]",
    "name": "name example"
}
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/username/{email} \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true
}
Modificare l'email di un utente
Parametri URL
  • token
    string
Attributes
  • email
    stringRequired
    `L'email dell'utente (studente o insegnante della tua accademia)`
  • newEmail
    stringRequired
    La nuova email
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/useremail
Request
Intestazioni di richiesta
Content-Type: application/json
Corpo della richiesta
{
    "email": "[email protected]",
    "newEmail": "[email protected]"
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/useremail \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "newEmail": "[email protected]",
    "ok": true
}
Richiedente/studente

L'oggetto ApplicantObject è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sugli studenti in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto Richiedente/studente
Attributes
  • applicantId
    number
    Identificatore dello studente
  • email
    string
    Email dello studente
  • link
    string
    Link per accedere alla sessione dal vivo per lo studente
  • name
    string
    Nome dello studente
  • students
    object
    Array di oggetti di studenti di corso
    Espandi attributiChiudi attributi
    • name
      string
      Nome dello studente
    • email
      string
      Email dello studente
    • content
      string
      Nome del corso
    • contentId
      number
      Identificatore del corso
    • applicantId
      number
      Identificatore dello studente
  • applicants
    object
    array di oggetti di studenti di sessione privata
    Espandi attributiChiudi attributi
    • name
      string
      Nome dello studente
    • email
      string
      Email dello studente
    • link
      string
      Link per accedere alla sessione dal vivo per lo studente
    • applicantId
      number
      Identificatore dello studente
  • isNewUser
    boolean
    Vero se l'utente è nuovo nel database e richiede una nuova password
  • password
    string
    Password (Solo se isNewUser è vero)
  • ok
    booleanRequired
    Restituisce vero se non si è verificato alcun errore, altrimenti restituisce falso
Cerca tra i tuoi studenti, ricerca per nome o email
Parametri URL
  • search
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/student/search/{search}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/student/search/{search}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "students": [
        {
            "name": "nombre ejemplo",
            "email": "[email protected]",
            "content": "título content",
            "contentId": 20940,
            "applicantId": 115218
        },
        ...
    ]
}
Aggiungi uno studente a un contenuto
Parametri URL
  • token
    string
Attributes
  • contentId
    numberRequired
    L'identificatore del contenuto
  • email
    stringRequired
    L'email dello studente
  • name
    stringRequired
    Il nome dello studente
  • themes
    arrayOptional
    Solo per quando il corso è per argomenti/moduli. Contiene un array di stringhe con gli argomenti ai quali si desidera aggiungere uno studente. Se non vengono indicati argomenti, lo studente viene aggiunto con tutti gli argomenti del corso disponibili.
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/content/student
Request
Intestazioni di richiesta
Content-Type: application/json
Corpo della richiesta
{
    "email": "[email protected]",
    "contentId": 32960,
    "name": "nombre alumno",
    "themes": ["34","40"] // Opcional, para añadir al alumno a un tema/as en concreto. Si no se añade la clave "themes" se añadirá al alumno con todos los temas
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/content/student \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=Xs9JH7T/neCiFL93TWAQfQ==",
    "name": "nombre alumno",
    "email": "[email protected]",
    "applicantId": 142829,
    "ok": true,
    "isNewUser": true,
    "password": "8476235" //sólo si es usuario nuevo
}
Rimuovi uno studente da un contenuto (multisessione o sessione unica)
Parametri URL
  • token
    string
Attributes
  • contentId
    stringRequired
    L'identificatore del contenuto
  • email
    stringRequired
    L'email dello studente
Definition
DELETE https://www.apiclassonlive.com/api/v1/{token}/content/student
Request
Intestazioni di richiesta
Content-Type: application/json
Corpo della richiesta
{
    "email": "[email protected]",
    "contentId": 32960
}
Esempio di richiesta
curl --request DELETE \
--url https://www.apiclassonlive.com/api/v1/{token}/content/student \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "contentId": 32960,
    "email": "[email protected]"
}
Richiedere dati di uno studente (multisessione o sessione unica)
Parametri URL
  • contentId
    string
  • token
    string
  • email
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/email/{email}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/email/{email}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=Xs9JH7T/neCiFL93TWAQfQ==",
    "name": "nombre alumno",
    "email": "[email protected]",
    "applicantId": 142831,
    "ok": true
}
Aggiungere studente/i a una sessione di contenuto particolare
Parametri URL
  • sessionId
    string
  • token
    string
Attributes
Definition
PUT https://www.apiclassonlive.com/api/v1/{token}/particolare/{sessionid}/addstudent
Request
Intestazioni di richiesta
Content-Type: application/json
Corpo della richiesta
{
    "students": [
        {
            "email":"[email protected]",
            "name":"nombre"
        },
        ...
    ]
}
Esempio di richiesta
curl --request PUT \
--url https://www.apiclassonlive.com/api/v1/{token}/particular/{sessionid}/addstudent \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "applicants": [
        {
            "applicantId": 142834,
            "email": "[email protected]",
            "name": "nombre",
            "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=g8FK3/hKIHVHaAqRZWrjZA==&claseParticolareId=85468"
        }
    ],
    "ok": true
}
Cancellare uno studente dalla sessione di contenuto particolare
Parametri URL
  • sessionId
    string
  • token
    string
Attributes
Definition
DELETE https://www.apiclassonlive.com/api/v1/{token}/particolare/{sessionid}/removestudent
Request
Intestazioni di richiesta
Content-Type: application/json
Corpo della richiesta
{
    "applicantId": 23734
}
Esempio di richiesta
curl --request DELETE \
--url https://www.apiclassonlive.com/api/v1/{token}/particular/{sessionid}/removestudent \
--header 'content-type: application/json'
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true
}
Richiedere gli studenti di un contenuto
Parametri URL
  • contentId
    string
  • token
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/student/findbycontent/{contentid}
Request
Esempio di richiesta
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/student/findbycontent/{contentid}
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "students": [
        {
            "minutesConnected": 0,
            "attended": false,
            "email": "[email protected]",
            "applicantId": 142832,
            "name": "nombre alumno",
            "userAccountId": 93098,
            "themes": "49780", // Si el alumno está apuntado a todos los temas el valor de "Themes" devolverá null, de lo contrario devolverá un String con los temas individuales adquiridos
        }
    ],
    "ok": true
}
Insegnanti

TeacherObject è l'oggetto restituito quando si effettua una richiesta in questa sezione. Questo oggetto mostra informazioni dettagliate sul docente in questione. A seconda della richiesta, l'oggetto può mostrare più o meno campi. Nella sezione “Corpo della risposta” di ogni richiesta è possibile vedere un esempio dettagliato dei campi restituiti da tale richiesta.

Oggetto Professore
Attributes
  • isNewUser
    boolean
    Vero se l'utente è nuovo nel database e richiede una nuova password password: (stringa) - Password (Solo se isNewUser è vero)
  • ok
    booleanRequired
    Restituisce vero se non si è verificato alcun errore, altrimenti restituisce falso
Aggiungere un docente alla tua accademia
Parametri URL
  • token
    string
Attributes
Definition
POST https://www.apiclassonlive.com/api/v1/{token}/teacher
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "email": "[email protected]"
}
Esempio di richiesta
curl --request POST \
--url https://www.apiclassonlive.com/api/v1/{token}/teacher \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true,
    "isNewUser": true,
    "paswword": "672773" //sólo si es usuario nuevo
}
Eliminare un docente dalla tua accademia
Parametri URL
  • token
    string
Attributes
Definition
DELETE https://www.apiclassonlive.com/api/v1/{token}/teacher
Request
Intestazioni della richiesta
Content-Type: application/json
Corpo della richiesta
{
    "teacher": "[email protected]"
}
Esempio di richiesta
curl --request DELETE \
--url https://www.apiclassonlive.com/api/v1/{token}/teacher \
--header 'content-type: application/json'
Response 200
Intestazioni della risposta
Content-Type: application/json
Corpo della risposta
{
    "ok": true
}
Progressi

Questi metodi restituiscono un oggetto chiamato “generale” dove appare il progresso generale di ogni studente e un oggetto “dettaglio” dove appare il progresso dettagliato di ogni risorsa dello studente.

Richiedere il progresso degli studenti di un contenuto

Metodo che restituisce il progresso degli studenti di un corso specifico. Il parametro pageNumber è facoltativo e serve per la paginazione. Es: 0 -> i primi 10 studenti, 1 -> i successivi 10 studenti.

Parametri URL
  • contentId
    string
  • token
    string
  • pageNumber
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/student/getstatsfromcontent/{contentid}/{pageNumber?}
Request
Richiesta di esempio
curl --request GET \
--url 'https://www.apiclassonlive.com/api/v1/{token}/student/getstatsfromcontent/{contentid}/{pageNumber?}='
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "stats": [
        {
            "general": {
                "progressPictureId": 16975101,
                "name": "nombre alumno",
                "registerDate": 1604331250000,
                "totalPercent": 33.33,
                "totalTime": 0,
                "applicantId": 1504891,
                "contentId": 123035,
                "email": "[email protected]",
                "register": 1604358000000,
                "country": null,
                "photo": null,
                "score": null,
                "status": null
            },
            "detail": [
                {
                    "progressPictureDetailId": 774634764,
                    "examTries": 0,
                    "name": "evaluacion",
                    "percent": null,
                    "resourceType": "exam",
                    "success": false,
                    "time": null,
                    "watched": false,
                    "moduleId": 111053,
                    "themeId": 24913,
                    "applicantId": 1504891,
                    "contentId": null,
                    "examId": 18551,
                    "resourceId": null,
                    "contentSessionId": null,
                    "contentExternalVideoId": null
                },
            ]
        }
    ],
    "num": 0,
    "totalPages": 1
}
Richiedere il progresso dello studente di un contenuto specifico
Parametri URL
  • token
    string
  • contentId
    string
  • applicantId
    string
Definition
GET https://www.apiclassonlive.com/api/v1/{token}/student/getuserstats/{contentid}/{applicantId}
Request
Richiesta di esempio
curl --request GET \
--url https://www.apiclassonlive.com/api/v1/{token}/student/getuserstats/{contentid}/{applicantId}
Response 200
Intestazioni di risposta
Content-Type: application/json
Corpo della risposta
{
    "progress":
        {
            "general": [
                {
                    "progressPictureId": 16975101,
                    "name": "nombre alumno",
                    "registerDate": 1604331250000,
                    "totalPercent": 33.33,
                    "totalTime": 0,
                    "applicantId": 1504891,
                    "contentId": 123035,
                    "email": "[email protected]",
                    "register": 1604358000000,
                    "country": null,
                    "photo": null,
                    "score": null,
                    "status": null
                },
            ]
            "detail": [
                {
                    "progressPictureDetailId": 774634764,
                    "examTries": 0,
                    "name": "eva",
                    "percent": null,
                    "resourceType": "exam",
                    "success": false,
                    "time": null,
                    "watched": false,
                    "moduleId": 111053,
                    "themeId": 24913,
                    "applicantId": 1504891,
                    "contentId": null,
                    "examId": 18551,
                    "resourceId": null,
                    "contentSessionId": null,
                    "contentExternalVideoId": null
                },
            ]
        }
    ],
    "num": 0,
    "totalPages": 1
}
Esempi
Creare contenuti per temi/moduli

Pincha qui per vedere un esempio di come creare un corso per temi.