Obtener Alumno por Filtros

Owned by angel
Mar 04, 2020

Descripción

Obtener Alumno por Filtros

Estatus
PREPRO

DEVELOP

DEVELOP

Request

DescripciónObtener Alumno por Filtros
Endpoint

/censo/empresas/{empresaId:[0-9]+}

/ciclos/{cicloEscolarId:[0-9]+}/colegios/{colegioId:[0-9]+}

/alumnosByFilters

TipoGET

Autenticación

si requiere token de authenticación
Alias

censo.get.alumnoByFilters

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

nui

integer
  • Opcional
  • Numero único de Identificación

nombre

string
  • Opcional

apellidoPaterno

string
  • Opcional

apellidoMaterno

string
  • Opcional

idOficial

string
  • Opcional


Permisos


EMPRESA

PAISSACIDSSUCCUADCOLDIRGCC_PALGG
MX.LIVEMéxico(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)
MX.RICHMéxico(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)
MX.UNOMéxico(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)
BR.UNOBrasil(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)
BR.FBBrasil(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)
BR.EDUCBrasil(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)
BR.RICHBrasil(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)(tick)


Ejemplo de llamada

https://www.basecentral.test/pegasus-api/censo/empresas/1/ciclos/249/colegios/1253/alumnosByFilters?nombre=angel&apellidoPaterno=lopez


Respuestas

200

{
    "success": true,
    "data": [
        {
            "nivel": {
                "nivelId": 16,
                "nivel": "Preescolar"
            },
            "grado": {
                "gradoId": 32,
                "grado": "Maternal"
            },
            "grupo": {
                "grupoId": 16,
                "grupo": "Grupo A",
                "grupoClave": "A"
            },
            "tieneDescuento": false,
            "demo": false,
            "articulos": {
                "programa": [],
                "digital": [],
                "servicio": [],
                "adicional": []
            },
            "observaciones": false,
            "promovido": true,
            "documentos": false,
            "documentosAplicados": false,
            "padre": [],
            "conPago": false,
            "ipadSincronizada": false,
            "login": "victoreduardo.jimenez.5",
            "countDocumento2Aplicados": 0,
            "countDocumento2Cancelados": 0,
            "alumnoId": 12481844,
            "persona": {
                "nombreCompleto": "VÍCTOR EDUARDO JIMÉNEZ TEST",
                "fechaNacimiento": "2017-08-02T00:00:00-0300",
                "personaLogin": [],
                "personaId": 6870667,
                "nombre": "VÍCTOR EDUARDO",
                "apellidoPaterno": "JIMÉNEZ",
                "apellidoMaterno": "TEST",
                "sexoMoral": "M",
                "idOficial": "XEXX010101HNEXXXA4",
                "extranjero": false
            },
            "fechaDesde": "2020-01-31T13:18:39-0200",
            "activo": true,
            "porcentajeDescuento": 0,
            "porcentajePago": 0,
            "razonDescuento": {
                "razonId": 0,
                "razon": "",
                "razonClave": ""
            },
            "razonInactivo": {
                "razonId": 0,
                "razon": "",
                "razonClave": ""
            },
            "razonValidacionId": 0,
            "hijoProfesor": false,
            "alumnoClave": "",
            "idResponsable": ""
        }
    ],
    "message": "success",
    "code": 200
}

401

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

Histórico de cambios

JiraDescripción

PSA-16697 - Getting issue details... STATUS

get alumno