Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jair Soto

Jair Soto

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Descripción


Estatus
PREPRO

Status
colourGreen
titleDEVELOP

Status
colourYellow
titleDEVELOP


Request

DescripciónEste servicio devuelve el resumen de descuentos por puntos para un colegio.
Endpoint/pegasus-api/censo/empresas/{empresaId}/ciclos/{cicloEscolarId}/colegios/{colegioId}/estadisticasDescuentos
TipoGET

Autenticación

Si
Aliascenso.get.estadisticasDescuentos


URL params

ParámetroTipoDescripción
empresaIdinteger
  • Obligatorio
  • Identificador de la empresa
cicloEscolarIdinteger
  • Obligatorio
  • Identificador del ciclo escolar
colegioIdinteger
  • Obligatorio
  • Identificador del colegio

Query params

ParámetroTipoDescripción
porcentajeMaxConDescuentointeger
  • Obligatorio
  • Establece el porcentaje máximo de descuentos permitidos.
porcentajeMininteger
  • Opcional
  • Establece el porcentaje mínimo de descuento permitido para el alumno.
  • Valor por defecto 20.
porcentajeMaxinteger
  • Opcional
  • Establece el porcentaje máximo de descuento permitido para el alumno.
  • Valor por defecto 40.



Permisos


EMPRESA

PAISSACIDSSUCCUADCOLDIRGCC_PALGG
MX.UNOMéxico(tick)(error)(error)(error)(tick)(error)(error)(error)(error)


Ejemplo de llamada

https://www.basecentral.test/pegasus-api/censo/empresas/1/ciclos/74/colegios/1253/estadisticasDescuentos?porcentajeMaxConDescuento=5


Respuestas

Status
colourGreen
title201

{
    "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
}

Status
colourRed
title401


Code Block
{
    "success": false,
    "data": "",
    "message": "Not Authorized",
    "code": 401
}



Histórico de cambios

JiraDescripción

Jira Legacy
serverSystem Jira
serverId487df0e8-a840-3c8c-bc14-813b0587c34e
keyPSA-16634

ResumenDescuentos