Lista de colegios por pais
Método: GET
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/prometeo/colegios/pais/44?cicloEscolarClave=2025
Parametros en la URL
cicloEscolarClave
: es la clave del ciclo escolar en el que se está navegando dentro de Prometeo
Ejemplo respuesta:
{ "success": true, "data": [ { "colegio": { "colegioId": 13240, "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-Teste Comp)", "colegioClave": "10001-TesteComp", "sapId": "10001-Teste Comp", "crmId": "", "persona": { "personaId": 9932455, "idFiscal": "03.877.256/0001-70", "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT" } }, "empresa": { "empresaId": 8, "empresa": "Editora Moderna Ltda", "empresaClave": "BR.SAN", "empresaParametro": "BR/COMP" } }, { "colegio": { "colegioId": 13241, "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-COMP TESTE)", "colegioClave": "10001-COMPTESTE", "sapId": "10001-COMP TESTE", "crmId": "", "persona": { "personaId": 9932465, "idFiscal": "03.877.256/0001-70", "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT" } }, "empresa": { "empresaId": 8, "empresa": "Editora Moderna Ltda", "empresaClave": "BR.SAN", "empresaParametro": "BR/COMP" } }, { "colegio": { "colegioId": 18039, "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-100001DOIS)", "colegioClave": "10001-100001DOIS", "sapId": "10001-100001DOIS", "crmId": "", "persona": { "personaId": 13473308, "idFiscal": "03877256000170", "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT" } }, "empresa": { "empresaId": 8, "empresa": "Editora Moderna Ltda", "empresaClave": "BR.SAN", "empresaParametro": "BR/COMP" } } ], "message": "success", "code": 200 }
data
: es un array los colegios de todo el país, donde cada ítem es un colegiodata[].colegio
contiene la información del colegiodata[].empresa
contiene la información de la empresa a la que pertenece el colegio
Lista de Colegios por CPNJ
Método: GET
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/prometeo/colegios/empresas/76/ciclos/1188/colegios?idFiscal=03.877.256/0001-70
Parametros en la URL
idFiscal
: Es el valor del CNPJ para buscar los colegios en una empresa que tienen el mismo valor
Ejemplo respuesta:
TBD
Clonar Colegio
Método: POST
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/prometeo/colegios/empresas/76/ciclos/1188/colegios/clonar
Payload
{ "colegios": [ { "empresaId": 7, "colegioId": 18168, "cicloEscolarId": 805 }, { "empresaId": 8, "colegioId": 18163, "cicloEscolarId": 785 }, { "empresaId": 34, "colegioId": 18173, "cicloEscolarId": 856 }, { "empresaId": 56, "colegioId": 18178, "cicloEscolarId": 838 } ] }
colegios
: Es un array que contiene la información de los colegios en los sellos que serán unificados en Santillana Educaçãocolegios[].empresaId
: Es el ID de la empresa sello del colegio que se quiere unificarcolegios[].colegioId
: Es el ID del colegio del sello que se quiere unificarcolegios[].cicloEscolarId
: Es el ID del ciclo escolar donde se encuentra el colegio dentro del sello
Instrucciones
Este servicio se debe usar cuando en Prometeo se ha seleccionado alguna de las siguientes acciones:
Crear una nueva Unificación
Enviar a Supercenso
Ya que este servicio se encarga de crear el colegio en el destino, en este caso Santillana Educaçao.
Los datos del colegio que es creado mediante este servicio se utilizan en el siguiente paso https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/808157292?draftShareId=eaff04b1-2a1d-41b2-8c75-26c0b1c67143#Iniciar-Unificaci%C3%B3n
Iniciar Unificación
Método: POST
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/unificacion/colegios
Payload:
{ "tipoUnificacion": "UNIFICAR_GENERAL", "destino": { "empresaId": 76, "colegioId": 18206, "cicloEscolarId": 1188 }, "origen": [ { "empresaId": 8, "colegioId": 18163, "cicloEscolarId": 785, "validaPago": false, "niveles": [ { "nivelId": 34, "soloCNC": false } ], "roles": [ { "rolId": 16, "rolClave": "AL" }, { "rolId": 18, "rolClave": "PROF" } ] } ] }
tipoUnificacion
: En un principio siempre debe tener el valorUNIFICAR_GENERAL
destino
: Son los valores de la empresa y colegio donde serán unificados los colegios seleccionadosempresaId
: Para la unificación siempre debe ser el ID de la empresa Santillana EducaçãocolegioId
: Es el ID del colegio dentro de la empresa Santillana Educação en el cual serán unificados los colegios del sellocicloEscolarId
: Es el ID del ciclo escolar que se está trabajando en Santillana Educação.
origen
: Es un array que debe contener los datos de cada uno de los colegios que van a ser unificadosempresaId
: Es el ID de la empresa sello donde se encuentra el colegio que se quiere unificarcolegioId
: Es el ID del colegio del sello que se quiere unificarcicloEscolarId
: Es el ID del ciclo escolar donde está el colegio dentro del sellovalidarPago
: Es un boolean que indica si al momento de unificar alumnos se debe considerar si ya cuentan con pago, por ahora siempre se debe enviar el valorfalse
true
: Se valida que los alumnos a unificar tengan un pago realizadofalse
: NO se valida si el alumno tiene un pago
niveles
: Es un array que contiene los niveles del colegio que serán unificadosniveles[].nivelId
: Es el ID del nivelniveles[].soloCNC
: Es un boolean que indica si solo se va a unificar el nivel sin unificar usuarios
roles
: Es un array que contiene los roles de los usuarios que serán unificadosroles[].rolId
: Es el ID del rol de los usuarios que se quieren unificarroles[].rolClave
: Es la clave del rol de los usuarios que se quieren unificar
Instrucciones
tipoUnificacion
: Siempre debe tener el valorUNIFICAR_GENERAL
destino
: Siempre deben ser los valores que corresponden a la empresa, colegio y ciclo escolar en Santillana Educaçãoorigen
: Contiene los datos de los colegios que se van a unificarvalidarPago
: SIEMPRE debe ir enfalse
roles
: Por ahora, SIEMPRE se deben enviar los siguientes 2 roles:"roles": [ { "rolId": 16, "rolClave": "AL" }, { "rolId": 18, "rolClave": "PROF" } ]