COMIENZO
API Endpoint
https://api.mqwapp.com/api
La API de Markqual provee acceso programático a datos de las respuestas de los exámenes creados y leídos con las herramientas desarrolladas por Markqual.
Para usar esta API se requiere una API key.
Link a la API: https://api.mqwapp.com
Api key
Todos los endpoints requieren que se les informe la apikey a utilizar.
La apikey debe ser agregada en el 'header' de la petición de la siguiente manera: auth_token:apikey
Ejemplo:
{
"auth_token":"CCAFDDRT-RN0Pa_GMJJ9-g8YKB0VX7H1zEeWR41BQvOB8EnP0qBAzTYB8EuaiBEZtur2eq4....."
}
La API key es informada dentro del sistema MarkQual: Menú 'Configuración' opción 'Configuración Pre Unab'.
Si necesita ayuda para encontrarla o quiere obtener su propia API key, no dude en contactarnos aquí -> Asercom
Exámenes tomados - resultados
# Ejemplo
curl \
-X POST https://api.mqwapp.com/api/examenes \
-H 'secret_key=your_api_key' \
-Body (JSON) {}
Para obtener los exámenes tomados de debe realizar una llamada POST a la siguiente url:
https://api.mqwapp.com/api/examenes
Ejemplo de body en el envío:
{
"cliente":"UNAB2023",
"año":"2023",
"mes":"5",
"colegio":"COLEGIO XXXX CCC DDDD",
"asignatura":"matemática",
"nivel":"IV",
"letra":"b"
}
Ejemplo de resultado:
[
{
"id": "78297",
"cliente": "UNAB2023",
"colegio": "COLEGIO XXXX CCC DDDD",
"asignatura": "matemática",
"nivel": "IV",
"letra": "b",
"tipoEnseñanza": "Media",
"año": "2023",
"mes": "5",
"fechaLectura": "05/02/2023 15:12:39",
"nombreEvaluacion": "C.Lectora"
},
{
"id": "79333",
"cliente": "UNAB2023",
"colegio": "COLEGIO XXXX CCC DDDD",
"asignatura": "matemática",
"nivel": "IV",
"letra": "B",
"tipoEnseñanza": "Media",
"año": "2023",
"mes": "5",
"fechaLectura": "05/03/2023 14:13:58",
"nombreEvaluacion": "Matematicas"
}
]
PARAMETROS
Los parámetros se envían en el body de la petición y en formato json.
Estos son los parámetros posibles.
| Campo | Tipo | Descripción |
|---|---|---|
| cliente | String | Código de cliente en MarkQual. |
| año | String | Año por el cual se está consultando. |
| mes | String | Mes por el cual se está consultando (1 a 12). |
| Colegio | String | (opcional) colegio por el cual se está consultando. |
| asignatura | String | (opcional) asignatura por la cual se está consultando |
| Nivel | String | (opcional) Nivel por el cual se está consultando. |
| Letra | String | Letra del curso por el cual se está consultando. |
Exámenes tomados - detalles
# Ejemplo
curl \
-X POST https://api.mqwapp.com/api/examenes/detallerespuestas \
-H 'secret_key=your_api_key' \
-Body (JSON) {}
Para obtener los exámenes tomados de debe realizar una llamada POST a la siguiente url:
https://api.mqwapp.com/api/examenes
Ejemplo de body en el envío:
{
"cliente":"UNAB2023",
"año":"2023",
"mes":"5",
"colegio":"COLEGIO XXXX CCC DDDD",
"asignatura":"matemática",
"nivel":"IV",
"letra":"b",
"FechaLectura":"20230510",
"NombreEvaluacion":"C.Lectora",
"TipoEnseñanza":"Media",
"IdAlumno":"555685854",
"ExamenId":"78589",
"PuntuacionDesde":"55",
"PuntuacionHasta":"65"
}
Ejemplo de resultado:
[
{
"examenId": "78297",
"idAlumno": "21525658",
"nombreAlumno": "CARTES, DIEGO ANTONIO",
"porcentajeLogro": "24.60",
"puntuacion": "16.00",
"cantidadPreguntas": "65.00",
"respuestasCorrectas": "16.00",
"respuestasErroneas": "49.00",
"respuestasOmitidas": "0.00",
"puntajeMaximoPosible": "65.00",
"cliente": "UNAB2023",
"fechaHoraIngreso": null,
"colegio": "COLEGIO XXXX CCC DDDD",
"tipoEnseñanza": "Media",
"nivel": "IV",
"letra": "C",
"asignatura": "Lenguaje y Comunicación",
"fechaLectura": "20230502",
"nombreEvaluacion": "C.Lectora",
"año": "2023",
"mes": "5"
},
{
"examenId": "78297",
"idAlumno": "216125489",
"nombreAlumno": "MORALES, VALENTINA SOFÍA",
"porcentajeLogro": "33.80",
"puntuacion": "22.00",
"cantidadPreguntas": "65.00",
"respuestasCorrectas": "22.00",
"respuestasErroneas": "43.00",
"respuestasOmitidas": "0.00",
"puntajeMaximoPosible": "65.00",
"cliente": "UNAB2023",
"fechaHoraIngreso": null,
"colegio": "COLEGIO XXXX CCC DDDD",
"tipoEnseñanza": "Media",
"nivel": "IV",
"letra": "C",
"asignatura": "Lenguaje y Comunicación",
"fechaLectura": "20230502",
"nombreEvaluacion": "C.Lectora",
"año": "2023",
"mes": "5"
}
]
PARAMETROS
Los parámetros se envían en el body de la petición y en formato json.
Estos son los parámetros posibles.
| Campo | Tipo | Descripción |
|---|---|---|
| cliente | String | Código de cliente en MarkQual. |
| año | String | Año por el cual se está consultando. |
| mes | String | mes por el cual se está consultando (1 a 12). |
| colegio | String | (opcional) colegio por el cual se está consultando. |
| asignatura | String | (opcional) asignatura por la cual se está consultando |
| nivel | String | (opcional) nivel por el cual se está consultando. |
| letra | String | (opcional) letra del curso por el cual se está consultando. |
| fechalectura | String | (opcional) fecha en la cual se hizo la lectura de las respuestas. (AAAAMMDD) |
| nombreevaluacion | String | (opcional) nombre de la evaluación en MarkQual. |
| tipoenseñanza | String | Tipo de enseñanza. (generalmente: media) |
| idalumno | String | (opcional) id o rut del alumno. |
| examenid | String | (opcional) id del examene que se desea conultar. |
| puntuaciondesde | String | (opcional) puntaje mínimo que se desea consultar. |
| puntuacionhasta | String | (opcional) puntaje máximo por el cual se desea consultar. |
Exámenes tomados - detalle de datos en el formulario
# Ejemplo
curl \
-X POST https://api.mqwapp.com/api/examenes \
-H 'secret_key=your_api_key' \
-Body (JSON) {}
Para obtener los datos de los formularios debe realizar una llamada POST a la siguiente url:
https://api.mqwapp.com/api/examenes/detalleformulario
Ejemplo de body en el envío:
{
"cliente":"UNAB2023",
"año":"2023",
"mes":"5"
}
Ejemplo de resultado:
[
{
"examenId": "76639",
"idAlumno": "146925683",
"nombreAlumno": "Salcedo, Alina Anahi",
"nombreEvaluacion": "C. LECTORA ENSAYO MASIVO",
"actividad": "00",
"carreras": "00000000000000000000000000000000000000000000000000000000000000000000",
"celular": " ",
"nivel": "010",
"curso": " 0",
"ensayo": "1000000",
"rbd": " ",
"regimen": "00",
"sede": "000",
"cliente": "UNAB2023",
"fechaLectura": "20230325",
"año": "2023",
"mes": "3"
},
{
"examenId": "76639",
"idAlumno": "168956935",
"nombreAlumno": "Jedlicky, Dominique",
"nombreEvaluacion": "C. LECTORA ENSAYO MASIVO",
"actividad": "00",
"carreras": "00000000000000000000000000000000000000000000000000000000000000000000",
"celular": " ",
"nivel": "000",
"curso": " 0",
"ensayo": "1000000",
"rbd": " ",
"regimen": "00",
"sede": "000",
"cliente": "UNAB2023",
"fechaLectura": "20230325",
"año": "2023",
"mes": "3"
}
]
PARAMETROS
Los parámetros se envían en el body de la petición y en formato json.
Estos son los parámetros posibles.
| Campo | Tipo | Descripción |
|---|---|---|
| cliente | String | Código de cliente en MarkQual. |
| año | String | Año por el cual se está consultando. |
| mes | String | Mes por el cual se está consultando (1 a 12). |
Parámetros posibles de lo exámenes consultados
# Ejemplo
curl \
-X POST https://api.mqwapp.com/api/examenes \
-H 'secret_key=your_api_key' \
-Body (JSON) {}
Con el propósito de conocer los posibles parámetros que existen en los datos de MarkQual, se desarrolla este endpoint.
Para obtener los datos de los formularios debe realizar una llamada POST a la siguiente url:
https://api.mqwapp.com/api/examenes/detalleformulario
Ejemplo de body en el envío:
{
"cliente":"UNAB2023",
"año":"2023",
"mes":"5"
}
Ejemplo de resultado:
[
{
"parametro": "Año",
"valores": [
"2023"
]
},
{
"parametro": "Mes",
"valores": [
"10",
"11",
"12",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
]
},
{
"parametro": "Colegio",
"valores": [
" COLEGIO COMPLEJO EDUCACIONAL ALBERTO WIDMER",
" COLEGIO LINCOLN COLLEGE DE HUECHURABA",
"ACADEMIA NAHUEL ",
"AMERICAN JUNIOR COLLEGE",
"BRITISH COLLEGE DE SAN FERNANDO",
"CENTRO DE ESTUDIOS IBERO",
"CENTRO EDUCACIONAL LA FLORIDA",
"CENTRO EDUCACIONAL LIFE SUPPORT"
]
},
{
"parametro": "Asignatura",
"valores": [
"Biología",
"Física",
"Historia, Geografía Y Ciencias Sociales",
"Lenguaje y Comunicación",
"Matemática",
"Química"
]
},
{
"parametro": "Nivel",
"valores": [
"I",
"II",
"III",
"IV"
]
},
{
"parametro": "Letra",
"valores": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K"
]
}
]
PARAMETROS
Los parámetros se envían en el body de la petición y en formato json.
Estos son los parámeteros posibles.
| Campo | Tipo | Descripción |
|---|---|---|
| cliente | String | Código de cliente en MarkQual. |
| año | String | Año por el cual se está consultando. |
| mes | String | (opcional) mes por el cual se está consultando (1 a 12). |
| colegio | String | (opcional) colegio por el cual se está consultando. |
| asignatura | String | (opcional) asignatura por la cual se está consultando |
| nivel | String | (opcional) nivel por el cual se está consultando. |
| letra | String | (opcional) letra del curso por el cual se está consultando. |
Errores
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"$": [
"JSON deserialization for type 'MQWebUnabApi.Models.ExamenesTomadosDTO' was missing required properties, including the following: año"
],
"examenesTomadosDTO": [
"The examenesTomadosDTO field is required."
]
},
"traceId": "00-ebfcace4b69f2b1a2168ddf2f27a0ca8-96289cca335535a2-00"
}
Una llamada exitosa a la api, siempre devuelve el status 200 OK
Una llamada no existosa devuelve otros status.
Esta API devuelve los siguientes errores:
| Status code | Significado |
|---|---|
| 401 | No autorizado: no se ha proporcionado una apikey válida. |
| 400 | Problemas con los datos proporcionados en el body. Generalmente que falte algun dato obligatorio. |