Versions Compared

Key

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

Descripción


Estatus
PREPRO

Status
colourYellow
titleDEVELOP

Status
colourYellow
titleDEVELOP


Request

DescripciónDescripción del servicioEndpointTipoGET, POST, PUT etcActivar / Inactivar Alumno
Endpointhttps://basecentral.test/pegasus-api/censo/empresas/{empresaId}/ciclos/{cicloEscolarId}/colegios/{colegioId}/niveles/{nivelId}grados/{gradoId}/grupos/{grupoId}/Alumnos/{alumnoId}/activarInactivar
TipoPOST

Autenticación

si requiere token de authenticación
Alias
enso.post.alumno.activarInactivar


URL params

ParámetroTipoDescripción
empresaIdinteger
  • Obligatorio
  • Identificador de la empresa
cicloEscolarIdinteger
  • Obligatorio
  • Identificador del colegio
colegioIdinteger
  • Obligatorio
  • Identificador del colegio
nivelIdinteger
  • Obligatorio
  • Identificador del nivel
gradoIdinteger
  • Obligatorio
  • Identificador del grado
grupoIdinteger
  • Obligatorio
  • Identificador del grupo
alumnoIdinteger
  • Obligatorio
  • Identificador del alumno

Query params

ParámetroTipoDescripción
activo
integer
razonInactivoId
integer
observaciones
string



Permisos

EMPRESA

PAISSACIDSSUCCUADCOLDIRGC

Unoi  MX

México

(tick)

(tick)

(tick)

(tick)

(tick)

(error)(error)

BE + Live

México

(tick)

(tick)

(tick)

(tick)

(tick)(tick)

(error)

(error)
Richmond TogheterMéxico






Richmond Solution

Brasil






  • Permisos básicos, pueden cambiar por empresa.

Ejemplo de llamada

URL de ejemplo de la llamada a la API


Respuestas

Status
colourGreen
title201


Code Block
{
    "success": true,
    "data": {
        "components": {
            "modules": [
                "ACUERDO",
                "CENSO"
            ],
            "cicloGlobalId": 74,
            "ciclosEscolares": [
                {
                    "cicloEscolarId": 25,
                    "cicloEscolar": "2015 - 2016",
                    "activo": 1,
                    "default": 0
                },
                {
                    "cicloEscolarId": 27,
                    "cicloEscolar": "2017 - 2018",
                    "activo": 1,
                    "default": 0
                },
                {
                    "cicloEscolarId": 73,
                    "cicloEscolar": "2018 - 2019",
                    "activo": 1,
                    "default": 0
                },
                {
                    "cicloEscolarId": 74,
                    "cicloEscolar": "2019 - 2020",
                    "activo": 1,
                    "default": 1
                },
                {
                    "cicloEscolarId": 23,
                    "cicloEscolar": "2013 - 2014",
                    "activo": 1,
                    "default": 0
                },
                {
                    "cicloEscolarId": 26,
                    "cicloEscolar": "2016 - 2017",
                    "activo": 1,
                    "default": 0
                }
            ]
        },
        "parametro": "GLOBAL"
    },
    "message": "success",
    "code": 201
}


Status
colourRed
title401


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



Histórico de cambios

JiraDescripción