Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Current »
Request
| Descripción | Este servicio devuelve el resumen de descuentos por puntos para un colegio.
|
|---|
| Endpoint | /pegasus-api/censo/empresas/{empresaId}/ciclos/{cicloEscolarId}/colegios/{colegioId}/estadisticasDescuentos |
|---|
| Tipo | GET
|
|---|
Autenticación | Si
|
|---|
| Alias | censo.get.estadisticasDescuentos |
|---|
URL params
| Parámetro | Tipo | Descripción |
|---|
| empresaId | integer | - Obligatorio
- Identificador de la empresa
|
| cicloEscolarId | integer | - Obligatorio
- Identificador del ciclo escolar
|
| colegioId | integer | - Obligatorio
- Identificador del colegio
|
Query params
| Parámetro | Tipo | Descripción |
|---|
| porcentajeMaxConDescuento | integer | - Obligatorio
- Establece el porcentaje máximo de descuentos permitidos.
|
| porcentajeMin | integer | - Opcional
- Establece el porcentaje mínimo de descuento permitido para el alumno.
- Valor por defecto 20.
|
| porcentajeMax | integer | - Opcional
- Establece el porcentaje máximo de descuento permitido para el alumno.
- Valor por defecto 40.
|
Respuestas
| {
"success": true,
"data": {
"totalAlumnos": 525,
"totalAlumnosContratados": 495,
"totalAlumnosDescuento": 58,
"limitePorcentaje": 5,
"limitePuntosDescuento": 980,
"totalPuntosAsignados": 1380,
"totalAlumnosPorPorcentaje": {
"alumnosPorcentajeMin": {
"porcentaje": 20,
"alumnos": 47,
"puntos": 940
},
"alumnosPorcentajeMax": {
"porcentaje": 40,
"alumnos": 11,
"puntos": 440
}
}
},
"message": "success",
"code": 200
} |
|---|
|
{
"success": false,
"data": "",
"message": "Not Authorized",
"code": 401
}
|
|---|
