Versions Compared

Key

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

...

Code Block
{
    "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"
            },
        },    "cicloEscolar": {
   {             "colegiocicloEscolarId": {786,
                "colegioIdcicloEscolar": 13241"2025",
                "colegiocicloEscolarClave": "INST2025"
 DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-COMP TESTE)",    },
            "colegioClaveniveles": "10001-COMPTESTE", [
                {
 "sapId": "10001-COMP TESTE",                 "crmIdnivelId": ""32,
                    "personanivel": { "Educação Infantil",
                    "personaIdnivelClave": 9932465,"001"
                },
   "idFiscal": "03.877.256/0001-70",            {
        "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT"    "nivelId": 34,
           }         "nivel": "Ensino Fundamental Anos },Finais",
                    "empresanivelClave": {"003"
                "empresaId": 8,},
                {
"empresa": "Editora Moderna Ltda",                 "empresaClavenivelId": "BR.SAN",35,
                    "empresaParametronivel": "BR/COMP"Ensino Médio",
            }         },"nivelClave": "004"
        {        }
            ]
        },
        {
            "colegio": {
                "colegioId": 1803913241,
                "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-100001DOISCOMP TESTE)",
                "colegioClave": "10001-100001DOISCOMPTESTE",
                "sapId": "10001-100001DOISCOMP TESTE",
                "crmId": "",
                "persona": {
                    "personaId": 134733089932465,
                    "idFiscal": "0387725600017003.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"
            },
        }    "cicloEscolar": {
                ],"cicloEscolarId": 786,
        "message        "cicloEscolar": "success2025",
                "codecicloEscolarClave": 200
}

...

"2025"
            },
            "niveles": [
                {
                    "nivelId": 32,
                    "nivel": "Educação Infantil",
                    "nivelClave": "001"
                }
            ]
        }
    ],
    "message": "success",
    "code": 200
}
  • data: es un array los colegios de todo el país, donde cada ítem es un colegio

    • data[].colegio contiene la información del colegio

    • data[].niveles contiene la información de los niveles en el colegio

    • data[].empresa contiene la información de la empresa a la que pertenece el colegio

    • data[].cicloEscolar contiene la información del ciclo escolar que corresponde al sello del 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:

Code Block
{
    "success": true,
    "data": [
        {
            "colegio": {
                "colegioId": 17919,
                "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-ENDERECO)",
                "colegioClave": "10001-SAED",
                "sapId": "10001-SAED",
                "crmId": "",
                "persona": {
                    "personaId": 13463168,
                    "idFiscal": "03.877.256/0001-70",
                    "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-ENDERECO)"
                }
            },
            "colegiosUnificados": [
                {
                    "colegio": {
                        "colegioId": 2856,
                        "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-PROVA UNOI)",
                        "colegioClave": "10001-PROVAUNOI",
                        "sapId": "10001-PROVA UNOI",
                        "crmId": "",
                        "persona": {
                            "personaId": 2131324,
                            "idFiscal": "03.877.256/0001-70",
                            "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT"
                        }
                    },
                    "empresa": {
                        "empresaId": 7,
                        "empresa": "Sistemas de Ensino UNO Ltda",
                        "empresaClave": "BR.UNO",
                        "empresaParametro": "BR/UNOI"
                    }
                },
                {
                    "colegio": {
                        "colegioId": 10023,
                        "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-RSOLUT)",
                        "colegioClave": "10001-RSOLUT",
                        "sapId": "10001-RSOLUT",
                        "crmId": "",
                        "persona": {
                            "personaId": 8161197,
                            "idFiscal": "03.877.256/0001-70",
                            "nombreCompleto": "INST DE ENS COL AMORIM SOCIED SIMPLES LT"
                        }
                    },
                    "empresa": {
                        "empresaId": 56,
                        "empresa": "Richmond Solutions",
                        "empresaClave": "BR.RICH",
                        "empresaParametro": "BR/RICH"
                    }
                },
                {
                    "colegio": {
                        "colegioId": 13244,
                        "colegio": "INST DE ENS COL AMORIM SOCIED SIMPLES LT(TESTE17-ENDERECO)",
                        "colegioClave": "10001-ENDERECO",
                        "sapId": "10001-ENDERECO",
                        "crmId": "",
                        "persona": {
                            "personaId": 9932614,
                            "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"
                    }
                }
            ]
        }
    ],
    "message": "success",
    "code": 200
}
  • data es un array que contiene los colegios que tienen el mismo CNPJ dentro de la empresa y ciclo indicados en la petición

    • data[].colegio contiene la información del colegio

    • data[].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:

...

    • colegiosUnificados es un array que contiene cada colegio de cada sello que está unificado dentro del colegio de supercenso

    • data[].colegiosUnificados.colegio contiene los datos del colegio del sello

    • data[].colegiosUnificados.empresa contiene los datos del sello unificado

Clonar Colegio

Método: POST

...