privado
180
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 48:
Linha 48: + + + + + + + + + + + + + + + + + + + + + Linha 92:
Linha 113: − + Linha 201:
Linha 222: − + Linha 308:
Linha 329: − + Linha 425:
Linha 446: − +
Gestão Escolar - API de integração (ver código-fonte)
Edição das 13h29min de 8 de abril de 2022
, 13h29min de 8 de abril de 2022→APIS para consultas
==APIS para consultas==
==APIS para consultas==
=== Estrutura da resposta ===
Cada resposta a uma requisição irá retornar uma estrutura de dados json do Seguinte formato:
{| class="wikitable"
|Campo
|Descrição
|-
|acao
|Mensagem de texto com o que foi retornado pela requisição
|-
|dados
|Array com os dados que foram requisitados na consulta. Caso esteja tudo correto é desse campo que os dados devem ser retirados para a consulta. Em caso de algum erro irá retornar vazio.
|-
|response
|Código HTTP que foi retornado (OK - 200, EXPECTATION_FAILED - 417 - Unauthorized - 401 , etc )
|-
|statusProcessamento
|Código interno Ultramax, para consultas (OK, ERRO)
|}
Todas as estruturas possíveis de retorno estão listadas abaixo:
===CURSOS: Obtendo dados:===
===CURSOS: Obtendo dados:===
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1 Exemplo])
Status 417:: Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1 Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/cursos?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1 Exemplo])
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1 Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/series?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1 Exemplo])
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1 Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/turmas?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1 Exemplo])
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1 Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])