API

API i-Educar

O i-Educar conta com uma API JSON que permite o acesso externo de outras aplicações. Para utilizá-la é necessário possuir o token que cada aplicação possui configurado no seu arquivo ieducar.ini.

Endpoints

Existem inúmeros endpoints disponíveis para consultar informações do i-Educar, mais abaixo há a listagem completa.

Como fazer uma requisição

A maior parte das requisições do i-Educar é feita utilizando o método HTTP GET e passando seus parâmetros via query string na URL para o endpoint que sempre começará com https://seudominio.com.br/module/Api/.

URL https://seudominio.com.br/module/Api/Aluno?access_key=abc123&oper=get&resource=aluno&id=1

Parâmetros obrigatórios

Existem 3 parâmetros obrigatórios que devem estar presentes em todas as requisições.

Nome	Tipo	Descrição
access_key	string	Token que se encontra no arquivo ieducar.ini
oper	string	Indica qual operação deve ser realizada (get/put/post/delete)
resource	string	Indica qual recurso é requisitado

Parâmetro modified

Alguns endpoints permitem que o parâmetro modified seja informado para que os resultados obtidos sejam apenas os que foram modificados após a data passada via parâmetro.

A data deve seguir o formato 2019-01-01T00:00:00.

Respostas padrões

• access_key inválido:

{
  "oper":"get",
  "resource":"aluno-search",
  "msgs":[
    {
      "msg":"Chave de acesso inv\u00e1lida!",
      "type":"error"
    }
  ],
  "any_error_msg":true
}

• Sem access_key:

{
  "oper":"get",
  "resource":"aluno-search",
  "msgs": [
    {
      "msg":"Usu\u00e1rio deve estar logado ou a chave de acesso deve ser enviada!",
      "type":"error"
    }
  ],
  "any_error_msg":true
}

Endpoints disponíveis

• Recuperar nome e código do aluno
• Recuperar matrículas de alunos
• Recuperar boletim de um aluno
• Recuperar informações de um aluno
• Recuperar ocorrências disciplinares de um aluno
• Recuperar todos alunos
• Recuperar alunos pelo cpf do pai, mãe ou responsável
• Recuperar cursos
• Recuperar séries
• Recuperar deficiências
• Recuperar informacoes das escolas
• Retornar turmas por escola
• Retornar areas de conhecimento
• Retornar disciplinas
• Retornar servidores com vínculos de turmas e disciplinas naquele ano
• Retornar alunos de determinada turma
• Retornar alunos de determinada turma que estiverem em exame
• Retornar tabelas de arredondamento
• Retornar regras
• Retornar regras de recuperação
• Postar notas
• Postar faltas por componente
• Postar faltas geral
• Postar pareceres por etapa e componente
• Postar pareceres por etapa geral
• Postar pareceres anual por componente
• Postar pareceres anual geral
• Recuperar etapas por escola
• Recuperar bloqueio de faixa etária em série
• Recuperar alunos matriculados
• Recuperar boletim do professor
• Retornar movimentações de enturmações
• Retornar alunos com dependência

Recuperar nome e código do aluno

URL /module/Api/Aluno?oper=get&resource=aluno-search&query=ciclano

Parâmetros

Nome	Tipo	Descrição
*query	string	Campo de pesquisa do nome, código do aluno ou código
escola_id	integer	Código da escola em que o aluno está matriculado. Se esse parâmetro não for enviado trará alunos de todas escolas, incluindo alunos não matriculados

* Parâmetro obrigatório

Exemplos de resposta:

{
  "result":{
    "1":"1 - Fulaninho da Silva",
    "2":"2 - Ciclado Soares",
    "3":"3 - Beltrano Rodrigues"
  },
  "oper":"get",
  "resource":"aluno-search",
  "msgs":[],
  "any_error_msg":false
}

Recuperar matrículas de alunos

URL /module/Api/Aluno?oper=get&resource=matriculas&aluno_id=1

Parâmetros

Nome	Tipo	Descrição
*aluno_id	integer ou array	Código do aluno, ou array de alunos
only_valid_boletim	boolean	Enviar como true caso deseja apenas matrículas com informações de turma e boletim por turma

* Parâmetro obrigatório

Exemplos de resposta:

{
    "any_error_msg": false,
    "matriculas": [
        {
            "aluno_id": "1",
            "aluno_nome": "Fulaninho da Silva",
            "ano": "2019",
            "curso_id": "1",
            "curso_nome": "Ensino Fundamental - 8 Anos (s\u00e9ries Finais)",
            "data_entrada": "01/01/2019",
            "data_saida": [],
            "escola_id": "1",
            "escola_nome": "Escolinha",
            "id": "1001",
            "instituicao_id": "1",
            "serie_id": "1",
            "serie_nome": "1\u00aa S\u00e9rie",
            "situacao": "Aprovado",
            "transferencia_em_aberto": false,
            "turma_id": "111",
            "turma_nome": "1\u00aa S\u00e9rie",
            "ultima_enturmacao": "",
            "user_can_access": true
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "matriculas"
}

Recuperar boletim do aluno

URL /module/Api/Report?oper=get&resource=boletim&matricula_id=1001&escola_id=1

Parâmetros

Nome	Tipo	Descrição
*matricula_id	integer	Código do matrícula do aluno
*escola_id	integer	Código da escola em que o aluno está matriculado

* Parâmetro obrigatório

Exemplos de resposta:

{
    "any_error_msg": false,
    "encoded": "(código gigante)",
    "encoding": "base64",
    "matricula_id": "1001",
    "msgs": [],
    "oper": "get",
    "resource": "boletim"
}

Recuperar informações de um aluno

URL /module/Api/Aluno?oper=get&resource=aluno&id=1

Parâmetros

Nome	Tipo	Descrição
*id	integer	Código do aluno

* Parâmetro obrigatório

Exemplos de resposta

{
    "alfabetizado": true,
    "aluno_estado_id": null,
    "aluno_inep_id": null,
    "any_error_msg": false,
    "ativo": true,
    "beneficio_id": null,
    "beneficios": {
        "1": "Bolsa Fam\u00edlia"
    },
    "codigo_sistema": "",
    "destroyed_at": null,
    "destroyed_by": null,
    "id": "1524",
    "justificativa_falta_documentacao": null,
    "msgs": [],
    "nome": "Fulaninho da Silva",
    "oper": "get",
    "pessoa_id": "1",
    "projetos": [],
    "religiao_id": null,
    "resource": "aluno",
    "sus": null,
    "tipo_responsavel": "outra_pessoa",
    "tipo_transporte": "nenhum",
    "url_laudo_medico": null
}

Recuperar ocorrências disciplinares de um aluno

URL /module/Api/Aluno?oper=get&resource=ocorrencias_disciplinares&aluno_id=1&escola=1

Parâmetros

Nome	Tipo	Descrição
*aluno_id	integer ou array	Código do aluno
*escola	integer	Código da escola
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "msgs": [],
    "ocorrencias_disciplinares": [
        {
            "data_hora": "01/01/2019 00:00:00",
            "descricao": "Aluna chegou atrasado por 2 dias consecutivos, em 29 e 30/04 nas primeiras aulas e a Coordena\u00e7\u00e3o de ensino n\u00e3o identificou ainda a raz\u00e3o.",
            "ocorrencia_disciplinar_id": "3084021",
            "tipo": "Atraso No Hor\u00e1rio De Entrada",
            "aluno_id": 1,
            "escola_id" : 1,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        }
    ],
    "oper": "get",
    "resource": "ocorrencias_disciplinares"
}

Recuperar todos alunos

URL /module/Api/Aluno?oper=get&resource=todos-alunos&instituicao_id=1&escola=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*escola	integer	Código da escola
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "alunos": [
        {
            "aluno_id": "1",
            "nome_aluno": " Fulaninho da Silva",
            "nome_social": "Fulaninho da Silva",
            "foto_aluno":  "<url>",
            "data_nascimento": "11/11/2000",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "aluno_id": "2",
            "nome_aluno": " Ciclado Soares",
            "nome_social": "",
            "foto_aluno": "<url>",
            "data_nascimento": "01/01/2000",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "aluno_id": "3",
            "nome_aluno": " Beltrano Rodrigues",
            "nome_social": "Beltrano Rodrigues",
            "foto_aluno": "<url>",
            "data_nascimento": "20/02/2002",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        }
    ],
    "any_error_msg": false,
    "msgs": [],
    "oper": "get",
    "resource": "todos-alunos"
}

Recuperar cursos

URL /module/Api/Curso?oper=get&resource=cursos&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
escola_id	integer ou array	Código da(s) escola(s) - Obrigatório quando get_turmas for true
get_series	boolean	Padrão false, passar como true caso queira que séries dos cursos venham agrupadas - Obrigatório quando get_turmas for true
ano	integer	Ano letivo - Obrigatório quando get_turmas for true
get_turmas	boolean	Padrão false, passar como true caso queira que turmas venham agrupadas junto as séries dos cursos
turno_id	integer	Filtra turmas por período. Parâmetros possíveis: 1: Matutino, 2: Vespertino, 3: Noturno, 4: Integral
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "cursos": [
        {
            "id": "1",
            "nome": "Ensino Fundamental - 8 Anos (S\u00e9ries Finais)",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "2",
            "nome": "Ensino Fundamental - 8 Anos (S\u00e9ries Iniciais)",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "3",
            "nome": "Ensino Fundamental - 9 Anos (Anos Finais)",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "4",
            "nome": "Ensino Fundamental - 9 Anos (Anos Iniciais)",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "cursos"
}

{
    "any_error_msg": false,
    "cursos": [
        {
            "id": "3",
            "nome": "Educa\u00e7\u00e3o de Jovens e Adultos-Finais",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "series": [
                {
                    "id": "86",
                    "nome": "3\u00aa Etapa-EJA"
                },
                {
                    "id": "87",
                    "nome": "4\u00aa Etapa-EJA"
                }
            ]
        },
        {
            "id": "7",
            "nome": "Educa\u00e7\u00e3o de Jovens e Adultos-Iniciais",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "series": [
                {
                    "id": "84",
                    "nome": "1\u00aa Etapa-EJA"
                },
                {
                    "id": "85",
                    "nome": "2\u00aa Etapa-EJA"
                }
            ]
        },
        {
            "id": "4",
            "nome": "Ensino Fundamental-8 Anos",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "series": [
                {
                    "id": "5",
                    "nome": "5\u00aa S\u00e9rie"
                },
                {
                    "id": "6",
                    "nome": "6\u00aa S\u00e9rie"
                },
                {
                    "id": "7",
                    "nome": "7\u00aa S\u00e9rie"
                },
                {
                    "id": "8",
                    "nome": "8\u00aa S\u00e9rie"
                }
            ]
        },
        {
            "id": "5",
            "nome": "Ensino Fundamental-9 Anos Finais",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "series": [
                {
                    "id": "37",
                    "nome": "6\u00b0 Ano"
                }
            ]
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "cursos"
}

{
    "any_error_msg": false,
    "cursos": [
        {
            "id": "35",
            "nome": "Ensino Fundamental I (1\u00ba ao 5\u00ba ANO)",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "series": [
                {
                    "id": "20",
                    "nome": "1\u00ba Ano",
                    "turmas": [
                        {
                            "cod_turma": "561",
                            "nm_turma": "01\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "722",
                            "nm_turma": "01\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "562",
                            "nm_turma": "01\u00ba ano B",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "721",
                            "nm_turma": "01\u00ba ano B",
                            "turma_turno_id": "2"
                        }
                    ]
                },
                {
                    "id": "17",
                    "nome": "2\u00ba Ano",
                    "turmas": [
                        {
                            "cod_turma": "560",
                            "nm_turma": "02\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "727",
                            "nm_turma": "02\u00ba ano A",
                            "turma_turno_id": "2"
                        }
                    ]
                },
                {
                    "id": "29",
                    "nome": "3\u00ba Ano",
                    "turmas": [
                        {
                            "cod_turma": "565",
                            "nm_turma": "03\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "728",
                            "nm_turma": "03\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "566",
                            "nm_turma": "03\u00ba ano B",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "729",
                            "nm_turma": "03\u00ba ano B",
                            "turma_turno_id": "2"
                        }
                    ]
                },
                {
                    "id": "1",
                    "nome": "4\u00ba Ano",
                    "turmas": [
                        {
                            "cod_turma": "556",
                            "nm_turma": "04\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "723",
                            "nm_turma": "04\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "557",
                            "nm_turma": "04\u00ba ano B",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "724",
                            "nm_turma": "04\u00ba ano B",
                            "turma_turno_id": "2"
                        }
                    ]
                },
                {
                    "id": "15",
                    "nome": "5\u00ba Ano",
                    "turmas": [
                        {
                            "cod_turma": "558",
                            "nm_turma": "05\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "725",
                            "nm_turma": "05\u00ba ano A",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "559",
                            "nm_turma": "05\u00ba ano B",
                            "turma_turno_id": "2"
                        },
                        {
                            "cod_turma": "726",
                            "nm_turma": "05\u00ba ano B",
                            "turma_turno_id": "2"
                        }
                    ]
                }
            ]
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "cursos"
}

Recuperar séries

URL /module/Api/Serie?oper=get&resource=series&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*escola_id	integer ou array	Código da(s) escola(s)
*curso_id	integer ou array	Código do(s) curso(s)
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "msgs": [],
    "oper": "get",
    "resource": "series",
    "series": [
        {
            "id": "1",
            "nome": "1\u00ba Ano",
            "idade_padrao": "6",
            "curso_id": "1",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "2",
            "nome": "2\u00ba Ano",
            "idade_padrao": "7",
            "curso_id": "1",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "3",
            "nome": "3\u00ba Ano",
            "idade_padrao": "8",
            "curso_id": "1",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        }
    ]
}

Recuperar deficiências

URL /module/Api/Deficiencia?oper=get&resource=deficiencias

Exemplos de resposta

{
    "any_error_msg": false,
    "deficiencias": [
        {
            "id": "1",
            "nome": "1 - M\u00faltipla - M",
            "desconsidera_regra_diferenciada": false,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "alunos": [1]
        },
        {
            "id": "2",
            "nome": "2 - Cegueira - C",
            "desconsidera_regra_diferenciada": false,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "alunos": [4, 6, 89]
        },
        {
            "id": "3",
            "nome": "3 - Baixa Vis\u00e3o - BV",
            "desconsidera_regra_diferenciada": false,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "alunos": [5, 986, 23]
        },
        {
            "id": "4",
            "nome": "4 - Surdez Severa ou Profunda - SS",
            "desconsidera_regra_diferenciada": false,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null,
            "alunos": [45, 123, 56]
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "deficiencias"
}

Recuperar informacoes das escolas

Recupera os dados de todas escolas cadastradas no sistema

URL /module/Api/Escola?oper=get&resource=info-escolas

Parâmetros Nenhum

Exemplos de resposta

{
    "escolas": [
        {
            "cod_escola": "1",
            "nome": "Escolinha",
            "cep": "11111222",
            "numero": null,
            "complemento": null,
            "logradouro": "Rua da Escola",
            "bairro": "Educação",
            "municipio": "Modelópolis",
            "uf": "SC",
            "pais": "Brasil",
            "email": "[email protected]",
            "ddd": "11",
            "fone": "11223344",
            "nome_responsavel": null,
            "inep": null
        }
    ],
    "oper": "get",
    "resource": "info-escolas",
    "msgs": [],
    "any_error_msg": false
}

Exemplo de resposta sem dados

{
    "escolas": 0,
    "oper": "get",
    "resource": "escolas",
    "msgs": [
        {
            "msg": "Desculpe, mas aparentemente não existem escolas cadastradas.",
            "type": "error"
        }
    ],
    "any_error_msg": true
}

Retornar turmas por escola

Retorna informações de turma por escola

URL /module/Api/Turma?oper=get&resource=turmas-por-escola&instituicao_id=1&escola=1&ano=2019

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*escola	integer	ID da escola
*ano	integer	Ano
turno_id	integer	Filtra turmas por período. Parâmetros possíveis: 1: Matutino, 2: Vespertino, 3: Noturno, 4: Integral
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "msgs": [],
    "oper": "get",
    "resource": "turmas-por-escola",
    "turmas": [
        {
            "id": "292",
            "nome": "1º ANO ",
            "ano": "2019",
            "escola_id": "3",
            "turno_id": "1",
            "curso_id": "4",
            "serie_id": "9",
            "regra_avaliacao_id": "3",
            "regra_avaliacao_diferenciada_id": null,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "293",
            "nome": "2º  ANO  ",
            "ano": "2019",
            "escola_id": "3",
            "turno_id": "1",
            "curso_id": "4",
            "serie_id": "15",
            "regra_avaliacao_id": "3",
            "regra_avaliacao_diferenciada_id": null,
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": "2019-01-02 00:00:00"
        }
    ]
}

Retornar areas de conhecimento

Retorna áreas de conhecimento de uma instituição

URL /module/Api/AreaConhecimento?oper=get&resource=areas-de-conhecimento&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "areas": [
        {
            "id": "10",
            "nome": "1\u00ba Ano - Artes",
            "ordenamento_ac": "99999",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "11",
            "nome": "1\u00ba Ano - Educa\u00e7\u00e3o F\u00edsica",
            "ordenamento_ac": "99999",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "9",
            "nome": "1\u00ba Ano - Objetivos",
            "ordenamento_ac": "99999",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "7",
            "nome": "ARTES",
            "ordenamento_ac": "99999",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "id": "3",
            "nome": "Ber\u00e7\u00e1rio (1 a 2 anos)",
            "ordenamento_ac": "99999",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "areas-de-conhecimento"
}

Retornar disciplinas

Retorna disciplinas de uma instituição

URL /module/Api/ComponenteCurricular?oper=get&resource=componentes-curriculares&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "disciplinas": [
        {
            "id": "20",
            "nome": "ALIMENTAÇÃO",
            "area_conhecimento_id": "4",
            "nome_area": "Educação infantil",
            "ordenamento": "99999",
            "updated_at": "2019-01-01 00:00:00"
        },
        {
            "id": "19",
            "nome": "ASPECTOS COGNITIVOS",
            "area_conhecimento_id": "4",
            "nome_area": "Educação infantil",
            "ordenamento": "99999",
            "updated_at": "2019-01-01 00:00:00"
        },
        {
            "id": "21",
            "nome": "ASPECTOS GERAIS",
            "area_conhecimento_id": "4",
            "nome_area": "Educação infantil",
            "ordenamento": "99999",
            "updated_at": "2019-01-01 00:00:00"
        }
    ],
    "msgs": [],
    "oper": "get",
    "resource": "componentes-curriculares"
}

Retornar servidores com vínculos de turmas e disciplinas naquele ano

Retornar servidores com vínculos de turmas e disciplinas naquele ano

URL /module/Api/Servidor?oper=get&resource=servidores-disciplinas-turmas&instituicao_id=1&ano=2019&escola=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*ano	integer	Ano
*escola	integer	Código da escola
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "msgs": [],
    "oper": "get",
    "resource": "servidores-disciplinas-turmas",
    "vinculos": [
        {
            "id": "",
            "servidor_id": "",
            "turma_id": "",
            "turno_id": "",
            "serie_id": "",
            "permite_lancar_faltas_componente": "",
            "tipo_nota": "",
            "updated_at": "",
            "deleted_at": "",
            "disciplinas": [1, 2, 3, 9, 11]
        }
    ]
}

Retornar alunos de determinada turma que estiverem em exame

Retorna os alunos de uma determinada turma e disciplina que estiverem em exame e a nota necessária

URL /module/Api/Turma?oper=get&resource=alunos-exame-turma

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*turma_id	integer	Código da turma
*disciplina_id	integer	Código da disciplina que possui alunos em exame

* Parâmetro obrigatório

Exemplos de resposta

{
    "alunos": [
        {
            "id": "30446",
            "nota_exame": "2.400"
        },
        {
            "id": "10606",
            "nota_exame": "2.100"
        }
    ],
    "any_error_msg": false,
    "msgs": [],
    "oper": "get",
    "resource": "alunos-exame-turma"
}

Retornar tabelas de arredondamento

Retornar tabelas de arredondamento

URL /module/Api/Regra?oper=get&resource=tabelas-de-arredondamento&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Exemplos de resposta

{
    "any_error_msg": false,
    "msgs": [],
    "oper": "get",
    "resource": "tabelas-de-arredondamento",
    "tabelas": [
        {
            "id": "2",
            "nome": "Tabela padrão de notas conceituais",
            "tipo_nota": "2",
            "valores": [
                {
                    "rotulo": "E",
                    "descricao": "Insuficiente",
                    "valor_maximo": "1.900",
                    "casa_decimal_exata": null,
                    "acao": null
                },
                {
                    "rotulo": "D",
                    "descricao": "Irregular",
                    "valor_maximo": "4.900",
                    "casa_decimal_exata": null,
                    "acao": null
                },
                {
                    "rotulo": "C",
                    "descricao": "Bom",
                    "valor_maximo": "6.900",
                    "casa_decimal_exata": null,
                    "acao": null
                },
                {
                    "rotulo": "B",
                    "descricao": "Muito bom",
                    "valor_maximo": "8.900",
                    "casa_decimal_exata": null,
                    "acao": null
                },
                {
                    "rotulo": "A",
                    "descricao": "Excelente",
                    "valor_maximo": "10.000",
                    "casa_decimal_exata": null,
                    "acao": null
                }
            ],
            "updated_at": "2019-06-05 11:36:27"
        }
    ]
}

Retornar regras

Retornar regras de avaliações e vínculo com turmas

URL /module/Api/Regra?oper=get&resource=regras&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

Tipos da resposta:

• tipo_nota

Valor	Descrição
0	Não usa nota
1	Nota numérica
2	Nota conceitual

• tipo_presenca

Valor	Descrição
1	Geral
2	Por componente

• parecer_descritivo

Valor	Descrição
0	Não utiliza
2	Um parecer por etapa e por componente curricular
3	Um parecer por etapa
5	Um parecer por ano letivo e por componente curricular
6	Um parecer por ano letivo, geral

• tipo_recuperacao

Valor	Descrição
0	Não utiliza
1	Utiliza recuperação paralela
2	Utiliza recuperação específica

Exemplos de resposta

{
  "regras": [
    {
        "id": "1",
        "tabela_arredondamento_id": "1",
        "tabela_arredondamento_id_conceitual": null,
        "tipo_nota": "1",
        "tipo_presenca": "2",
        "parecer_descritivo": "0",
        "tipo_recuperacao": "0",
        "media_recuperacao_paralela": null,
        "nota_maxima_geral": "10",
        "nota_maxima_exame": "10",
        "updated_at": "2019-01-01 00:00:00",
        "regra_diferenciada_id": "0"
    },
    {
        "id": "2",
        "tabela_arredondamento_id": "3",
        "tabela_arredondamento_id_conceitual": null,
        "tipo_nota": "2",
        "tipo_presenca": "1",
        "parecer_descritivo": "0",
        "tipo_recuperacao": "0",
        "media_recuperacao_paralela": null,
        "nota_maxima_geral": "10",
        "nota_maxima_exame": "10",
        "updated_at": "2019-01-01 00:00:00",
        "regra_diferenciada_id": "0"
    }

  ],
  "oper": "get",
  "resource": "regras",
  "msgs": [],
  "any_error_msg": false
}

Retornar regras de recuperação

URL /module/Api/Regra?oper=get&resource=regras-recuperacao&instituicao_id=1

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
modified	datetime	Apenas registros modificados após a data

* Parâmetro obrigatório

{
    "regras-recuperacao": [
        {
            "id": "3",
            "regra_avaliacao_id": "4",
            "descricao": "Rec1",
            "etapas_recuperadas": [
                "1",
                "2"
            ],
            "media": "6",
            "nota_maxima": "10",
            "updated_at": "2019-06-05 11:36:27",
            "deleted_at": null
        },
        {
            "id": "4",
            "regra_avaliacao_id": "4",
            "descricao": "Rec2",
            "etapas_recuperadas": [
                "3",
                "4"
            ],
            "media": "6",
            "nota_maxima": "10",
            "updated_at": "2019-06-05 11:36:27",
            "deleted_at": null
        }
    ],
    "oper": "get",
    "resource": "regras-recuperacao",
    "msgs": [],
    "any_error_msg": false
}

Postar notas

Recebe notas e processa com o serviço boletim

URL /module/Api/Diario?oper=post&resource=notas

Parâmetros

Nome	Tipo	Descrição
*etapa	integer	Etapa
*notas	array	Array contendo os campos relacionados na tabela abaixo

Array notas

O array de notas é um array com diversas camadas e cada uma é indexada por vários ids:

{
  "notas": {
    "770": {
      "1978": {
        "10": {
          "nota": "6.0",
          "recuperacao": "2.0"
        }
      }
    }
  }
}

Onde:

770: turma_id
1978: aluno_id
10: componente_curricular_id

Obs.: O campo recuperação deve ser sempre enviado pois é uma regra no i-Educar.

Exemplos

/module/Api/Diario?access_key=abc1234&etapa=2&instituicao_id=1&notas%5B770%5D%5B2837%5D%5B9%5D%5Bnota%5D=7.5&notas%5B770%5D%5B2837%5D%5B9%5D%5Brecuperacao%5D=5.5&oper=post&resource=notas&secret_key=aaI3nesS7om3GrrsCY1bEVPWfjM%253D

Exemplos de resposta

• Sem erro:

{
  "oper": "post",
  "resource": "notas",
  "msgs": [
    {
      "msg": "Notas postadas com sucesso!",
      "type": "success"
    }
  ],
  "any_error_msg": false
}

• Com erros:

{
  "oper": "post",
  "resource": "notas",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

Postar recuperações

Recebe notas e processa com o serviço boletim

URL /module/Api/Diario?oper=post&resource=recuperacoes

Parâmetros

Nome	Tipo	Descrição
*etapa	integer	Etapa
*notas	array	Array contendo os campos relacionados na tabela abaixo

Array notas

O array de notas é um array com diversas camadas e cada uma é indexada por vários ids:

{"notas":
  {"770":
    {"1978":
      {"10":
        {"nota": "6.0", "recuperacao": "2.0"}
      }
    }
  }
}

Onde:

770: turma_id
1978: aluno_id
10: componente_curricular_id

Obs.: Este recurso é quase identico ao recurso de notas, a diferença é que este atualiza a nota do aluno caso a recuperação seja superior.

Exemplos

/module/Api/Diario?access_key=abc1234&etapa=2&instituicao_id=1&notas%5B770%5D%5B2837%5D%5B9%5D%5Bnota%5D=7.5&notas%5B770%5D%5B2837%5D%5B9%5D%5Brecuperacao%5D=5.5&oper=post&resource=recupercoes&secret_key=aaI3nesS7om3GrrsCY1bEVPWfjM%253D

Exemplos de resposta

• Sem erro:

{
  "oper": "post",
  "resource": "notas",
  "msgs": [
    {
      "msg": "Notas postadas com sucesso!",
      "type": "success"
    }
  ],
  "any_error_msg": false
}

• Com erros:

{
  "oper": "post",
  "resource": "notas",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

Postar faltas por componente

Recebe faltas por componente e processa com o Serviço Boletim

URL /module/Api/Diario?oper=post&resource=faltas-por-componente

Parâmetros

Nome	Tipo	Descrição
*etapa	integer	Etapa
*turmas	array	Array contendo os campos relacionados na tabela abaixo

Array turmas

Nome	Tipo	Descrição
*turma_id	integer	Código da turma
*alunos	array	Array contendo os campos relacionados na tabela abaixo

Array alunos

Nome	Tipo	Descrição
*aluno_id	integer	Código do aluno
*componentes_curriculares	array	Array contendo os campos relacionados na tabela abaixo

Array componentes_curriculares

Nome	Tipo	Descrição
*componente_curricular_id	integer	Código do componente currícular
*faltas	integer	Quantidade de faltas

* Parâmetro obrigatório

Exemplos

/module/Api/Diario?oper=post&resource=faltas-por-componente&access_key=abc1234&turmas[1][turma_id]=4534&etapa=4&turmas[1][alunos][1][aluno_id]=30371&turmas[1][alunos][1][componentes_curriculares][1][componente_curricular_id]=3190&turmas[1][alunos][1][componentes_curriculares][1][faltas]=5&turmas[1][alunos][1][componentes_curriculares][2][componente_curricular_id]=3191&turmas[1][alunos][1][componentes_curriculares][2][faltas]=4

Exemplos de resposta

• Sem erro:

{
    "any_error_msg": false,
    "msgs": [
        {
            "msg": "Faltas postadas com sucesso!",
            "type": "success"
        }
    ],
    "oper": "post",
    "resource": "faltas-por-componente"
}

• Com erros:

{
  "oper": "post",
  "resource": "faltas-por-componente",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

{
    "any_error_msg": true,
    "msgs": [
        {
            "msg": "Exception: A regra da turma 4534 n\u00e3o permite lan\u00e7amento de faltas por componente.",
            "type": "error"
        }
    ],
    "oper": "post",
    "resource": "faltas-por-componente"
}

Postar faltas geral

Recebe faltas geral e processa com o Serviço Boletim

URL /module/Api/Diario?oper=post&resource=faltas-geral

Parâmetros

Nome	Tipo	Descrição
*etapa	integer	Etapa
*turmas	array	Array contendo os campos relacionados na tabela abaixo

Array turmas

Nome	Tipo	Descrição
*turma_id	integer	Código da turma
*alunos	array	Array contendo os campos relacionados na tabela abaixo

Array alunos

Nome	Tipo	Descrição
*aluno_id	integer	Código do aluno
*faltas	integer	Quantidade de faltas

* Parâmetro obrigatório

Exemplos

/module/Api/Diario?oper=post&resource=faltas-geral&access_key=abc1234&turmas[1][turma_id]=4534&etapa=1&turmas[1][alunos][1][aluno_id]=30371&turmas[1][alunos][1][faltas]=10

Exemplos de resposta

• Sem erro:

{
    "any_error_msg": false,
    "msgs": [
        {
            "msg": "Faltas postadas com sucesso!",
            "type": "success"
        }
    ],
    "oper": "post",
    "resource": "faltas-geral"
}

• Com erros:

{
  "oper": "post",
  "resource": "faltas-geral",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

{
    "any_error_msg": true,
    "msgs": [
        {
            "msg": "Exception: A regra da turma 4534 n\u00e3o permite lan\u00e7amento de faltas geral.",
            "type": "error"
        }
    ],
    "oper": "post",
    "resource": "faltas-geral"
}

Postar pareceres por etapa e componente

Recebe pareceres por etapa e componente e processa com o Serviço Boletim

URL /module/Api/Diario?oper=post&resource=pareceres-por-etapa-e-componente

Parâmetros

Nome	Tipo	Descrição
*etapa	integer	Etapa
*turmas	array	Array contendo os campos relacionados na tabela abaixo

Array turmas

Nome	Tipo	Descrição
*turma_id	integer	Código da turma
*alunos	array	Array contendo os campos relacionados na tabela abaixo

Array alunos

Nome	Tipo	Descrição
*aluno_id	integer	Código do aluno
*componentes_curriculares	array	Array contendo os campos relacionados na tabela abaixo

Array componentes_curriculares

Nome	Tipo	Descrição
*componente_curricular_id	integer	Código do componente currícular
*parecer	text	Parecer descritivo

* Parâmetro obrigatório

Exemplos

/module/Api/Diario?oper=post&resource=pareceres-por-etapa-e-componente&access_key=abc1234&turmas[1][turma_id]=4534&etapa=4&turmas[1][alunos][1][aluno_id]=30371&turmas[1][alunos][1][componentes_curriculares][1][componente_curricular_id]=3190&turmas[1][alunos][1][componentes_curriculares][1][parecer]=parecer%20teste1&turmas[1][alunos][1][componentes_curriculares][2][componente_curricular_id]=3191&turmas[1][alunos][1][componentes_curriculares][2][parecer]=parecer%20teste2

Exemplos de resposta

• Sem erro:

{
    "any_error_msg": false,
    "msgs": [
        {
            "msg": "Pareceres postadas com sucesso!",
            "type": "success"
        }
    ],
    "oper": "post",
    "resource": "pareceres-por-etapa-e-componente"
}

• Com erros:

{
  "oper": "post",
  "resource": "pareceres-por-etapa-e-componente",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

{
    "any_error_msg": true,
    "msgs": [
        {
            "msg": "Exception: A regra da turma 4534 n\u00e3o permite lan\u00e7amento de pareceres por etapa e componente.",
            "type": "error"
        }
    ],
    "oper": "post",
    "resource": "pareceres-por-etapa-e-componente"
}

Postar pareceres por etapa geral

Recebe pareceres por etapa geral e processa com o Serviço Boletim

URL /module/Api/Diario?oper=post&resource=pareceres-por-etapa-geral

Parâmetros

Nome	Tipo	Descrição
*etapa	integer	Etapa
*turmas	array	Array contendo os campos relacionados na tabela abaixo

Array turmas

Nome	Tipo	Descrição
*turma_id	integer	Código da turma
*alunos	array	Array contendo os campos relacionados na tabela abaixo

Array alunos

Nome	Tipo	Descrição
*aluno_id	integer	Código do aluno
*parecer	text	Parecer descritivo

* Parâmetro obrigatório

Exemplos

/module/Api/Diario?oper=post&resource=pareceres-por-etapa-geral&access_key=abc1234&turmas[1][turma_id]=4534&etapa=1&turmas[1][alunos][1][aluno_id]=30371&turmas[1][alunos][1][parecer]=teste%20de%20parecer%20descritivo%20por%20etapa%20geral

Exemplos de resposta

• Sem erro:

{
    "any_error_msg": false,
    "msgs": [
        {
            "msg": "Pareceres postados com sucesso!",
            "type": "success"
        }
    ],
    "oper": "post",
    "resource": "pareceres-por-etapa-geral"
}

• Com erros:

{
  "oper": "post",
  "resource": "pareceres-por-etapa-geral",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

{
    "any_error_msg": true,
    "msgs": [
        {
            "msg": "Exception: A regra da turma 4534 n\u00e3o permite lan\u00e7amento de pareceres por etapa geral.",
            "type": "error"
        }
    ],
    "oper": "post",
    "resource": "pareceres-por-etapa-geral"
}

Postar pareceres anual por componente

Recebe pareceres anual por componente e processa com o Serviço Boletim

URL /module/Api/Diario?oper=post&resource=pareceres-anual-por-componente

Parâmetros

Nome	Tipo	Descrição
*turmas	array	Array contendo os campos relacionados na tabela abaixo

Array turmas

Nome	Tipo	Descrição
*turma_id	integer	Código da turma
*alunos	array	Array contendo os campos relacionados na tabela abaixo

Array alunos

Nome	Tipo	Descrição
*aluno_id	integer	Código do aluno
*componentes_curriculares	array	Array contendo os campos relacionados na tabela abaixo

Array componentes_curriculares

Nome	Tipo	Descrição
*componente_curricular_id	integer	Código do componente currícular
*parecer	text	Parecer descritivo

* Parâmetro obrigatório

Exemplos

/module/Api/Diario?oper=post&resource=pareceres-anual-por-componente&access_key=abc1234&turmas[1][turma_id]=4534&turmas[1][alunos][1][aluno_id]=30371&turmas[1][alunos][1][componentes_curriculares][1][componente_curricular_id]=3190&turmas[1][alunos][1][componentes_curriculares][1][parecer]=parecer%20tesasdasdate1&turmas[1][alunos][1][componentes_curriculares][2][componente_curricular_id]=3191&turmas[1][alunos][1][componentes_curriculares][2][parecer]=pareasdsadcer%20teste2

Exemplos de resposta

• Sem erro:

{
    "any_error_msg": false,
    "msgs": [
        {
            "msg": "Pareceres postados com sucesso!",
            "type": "success"
        }
    ],
    "oper": "post",
    "resource": "pareceres-anual-por-componente"
}

• Com erros:

{
  "oper": "post",
  "resource": "pareceres-anual-por-componente",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

{
    "any_error_msg": true,
    "msgs": [
        {
            "msg": "Exception: A regra da turma 4534 n\u00e3o permite lan\u00e7amento de pareceres anual por componente.",
            "type": "error"
        }
    ],
    "oper": "post",
    "resource": "pareceres-anual-por-componente"
}

Postar pareceres anual geral

Recebe pareceres anual geral e processa com o Serviço Boletim

URL /module/Api/Diario?oper=post&resource=pareceres-anual-geral

Parâmetros

Nome	Tipo	Descrição
*turmas	array	Array contendo os campos relacionados na tabela abaixo

Array turmas

Nome	Tipo	Descrição
*turma_id	integer	Código da turma
*alunos	array	Array contendo os campos relacionados na tabela abaixo

Array alunos

Nome	Tipo	Descrição
*aluno_id	integer	Código do aluno
*parecer	text	Parecer descritivo

* Parâmetro obrigatório

Exemplos

/module/Api/Diario?oper=post&resource=pareceres-anual-geral&access_key=abc1234&turmas[1][turma_id]=4534&turmas[1][alunos][1][aluno_id]=30371&turmas[1][alunos][1][parecer]=teste%20de%20parecer%20anual%20geral

Exemplos de resposta

• Sem erro:

{
    "any_error_msg": false,
    "msgs": [
        {
            "msg": "Pareceres postados com sucesso!",
            "type": "success"
        }
    ],
    "oper": "post",
    "resource": "pareceres-anual-geral"
}

• Com erros:

{
  "oper": "post",
  "resource": "pareceres-anual-geral",
  "msgs": [
    {
      "msg": "Exception: Não foi possível encontrar uma matrícula para o aluno 30371.",
      "type": "error"
    }
  ],
  "any_error_msg": true
}

{
    "any_error_msg": true,
    "msgs": [
        {
            "msg": "Exception: A regra da turma 4534 n\u00e3o permite lan\u00e7amento de pareceres anual geral.",
            "type": "error"
        }
    ],
    "oper": "post",
    "resource": "pareceres-anual-geral"
}

Recuperar etapas por escola

URL /module/Api/Escola?oper=get&resource=etapas-por-escola&instituicao_id

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
ano	integer	Ano

* Parâmetro obrigatório

Exemplos de resposta

{
    "escolas": [
        {
            "escola_id": "2",
            "ano": "2017",
            "descricao": "Anual",
            "etapas": [
                {
                    "etapa": "1",
                    "data_inicio": "2017-02-21",
                    "data_fim": "2017-12-22"
                }
            ],
            "etapas_de_turmas": []
        },
        {
            "escola_id": "3",
            "ano": "2019",
            "descricao": "Bimestre",
            "etapas": [
                {
                    "etapa": "1",
                    "data_inicio": "2019-01-28",
                    "data_fim": "2019-04-30"
                },
                {
                    "etapa": "2",
                    "data_inicio": "2019-05-02",
                    "data_fim": "2019-07-12"
                },
                {
                    "etapa": "3",
                    "data_inicio": "2019-08-01",
                    "data_fim": "2019-09-30"
                },
                {
                    "etapa": "4",
                    "data_inicio": "2019-10-01",
                    "data_fim": "2019-12-13"
                }
            ],
            "etapas_de_turmas": [
                {
                    "turma_id": "317",
                    "descricao": "Bimestre",
                    "etapas": [
                        {
                            "etapa": "1",
                            "data_inicio": "2019-01-28",
                            "data_fim": "2019-04-30"
                        },
                        {
                            "etapa": "2",
                            "data_inicio": "2019-05-02",
                            "data_fim": "2019-07-12"
                        },
                        {
                            "etapa": "3",
                            "data_inicio": "2019-08-01",
                            "data_fim": "2019-09-30"
                        },
                        {
                            "etapa": "4",
                            "data_inicio": "2019-10-01",
                            "data_fim": "2019-12-13"
                        }
                    ]
                },
                {
                    "turma_id": "318",
                    "descricao": "Bimestre",
                    "etapas": [
                        {
                            "etapa": "1",
                            "data_inicio": "2019-01-28",
                            "data_fim": "2019-04-30"
                        },
                        {
                            "etapa": "2",
                            "data_inicio": "2019-05-02",
                            "data_fim": "2019-07-12"
                        },
                        {
                            "etapa": "3",
                            "data_inicio": "2019-08-01",
                            "data_fim": "2019-09-30"
                        },
                        {
                            "etapa": "4",
                            "data_inicio": "2019-10-01",
                            "data_fim": "2019-12-13"
                        }
                    ]
                }
            ]
        }
    ],
    "oper": "get",
    "resource": "etapas-por-escola",
    "msgs": [],
    "any_error_msg": false
}

A chave etapas traz as etapas padrões para a escola, enquanto a chave etapas_de_turmas traz as etapas específicas cadastradas para cada turma.

Recuperar bloqueio de faixa etária em série

Este recurso verifica se existe bloqueio de idade da série de acordo com a data de nascimento enviada

URL /module/Api/Serie?oper=get&resource=bloqueio-faixa-etaria

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*serie_id	integer	Código da série
*data_nascimento	date	Data de nascimento a ser verificada, formato y-m-d
ano	integer	Ano base utilzado no cálculo (Se este não for enviado será usado o ano atual)

* Parâmetro obrigatório

Exemplos de resposta

{
    "bloqueado": false,
    "mensagem_bloqueio": "",
    "oper": "get",
    "resource": "bloqueio-faixa-etaria",
    "msgs": [ ],
    "any_error_msg": false
}

Recuperar alunos matriculados

Este recurso retorna id dos alunos matriculados conforme parâmetros informados

URL /module/Api/Aluno?oper=get&resource=alunos-matriculados&instituicao_id=1&escola_id=1&data=2019-01-01&ano=2019

Parâmetros

Nome	Tipo	Descrição
*instituicao_id	integer	Código da instituição
*escola_id	integer	Código da escola
*ano	integer	Ano
*data	date	Data da matrícula no formato y-m-d
turno_id	integer	Código do turno
serie_id	integer	Código da série
turma_id	integer	Código da turma

* Parâmetro obrigatório

Exemplos de resposta

{
  "alunos": [
    {
      "aluno_id": "5271",
      "dependencia": false,
      "sequencia": "0",
      "data_enturmacao": "2016-02-05"
    },
    {
      "aluno_id": "839",
      "dependencia": false,
      "sequencia": "0",
      "data_enturmacao": "2016-02-05"
    },
    {
      "aluno_id": "4410",
      "dependencia": false,
      "sequencia": "0",
      "data_enturmacao": "2016-02-05"
    },
    {
      "aluno_id": "3689",
      "dependencia": false,
      "sequencia": "0",
      "data_enturmacao": "2016-02-05"
    },
    {
      "aluno_id": "4638",
      "dependencia": true,
      "sequencia": "1",
      "data_enturmacao": "2016-04-06"
    }
  ],
  "oper": "get",
  "resource": "alunos-matriculados",
  "msgs": [ ],
  "any_error_msg": false
}

Recuperar boletim do professor

Este recurso retorna o boletim do professor emitido conforme parâmetros informados

URL /module/Api/Report?oper=get&resource=boletim-professor

Parâmetros

Nome	Tipo	Descrição
*ano	integer	Ano
*instituicao_id	integer	Código da instituição
*escola_id	integer	Código da escola
*curso_id	integer	Código do curso
*serie_id	integer	Código da série
*turma_id	integer	Código da turma
*componente_curricular_id	integer	Código do componente curricular
professor	string	Nome do professor a ser emitido

* Parâmetro obrigatório

Exemplos de resposta

{
  "encoding": "base64",
  "encoded": "(arquivo em base64)",
  "oper": "get",
  "resource": "boletim-professor",
  "msgs": [ ],
  "any_error_msg": false
}

Retornar movimentações de enturmações

Este recurso retorna as movimentações das enturmações em determinado ano e escola.

URL /module/Api/Matricula?oper=get&resource=movimentacao-enturmacao

Parâmetros

Nome	Tipo	Descrição
*ano	integer	Ano
escola	integer	Código da escola
modified	datetime	Apenas registros modificados após a data

Exemplos de resposta

{
    "enturmacoes":[
        {
            "id": "1",
            "turma_id": "1",
            "matricula_id": "1",
            "sequencial": "1",
            "sequencial_fechamento": "1",
            "data_entrada": "2019-01-01",
            "data_saida": null,
            "apresentar_fora_da_data": "f",
            "turno_id": "1",
            "updated_at": "2019-01-01",
            "deleted_at": null
        }
    ]
}

Retornar alunos com dependência

Este recurso retorna os alunos que possuem dependência com as informações de matricula_id e disciplina_id.

URL /module/Api/Matricula?oper=get&resource=matriculas-dependencia&ano=2019&escola=1

Parâmetros

Nome	Tipo	Descrição
*ano	integer	Ano
*escola	integer	Código da escola
modified	datetime	Apenas registros modificados após a data

Exemplos de resposta

{
"matriculas": [
        {
            "matricula_id": "494371",
            "disciplina_id": "8",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "matricula_id": "497242",
            "disciplina_id": "3",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        },
        {
            "matricula_id": "497468",
            "disciplina_id": "192",
            "updated_at": "2019-01-01 00:00:00",
            "deleted_at": null
        }
    ],
    "oper": "get",
    "resource": "matriculas-dependencia",
    "msgs": [ ],
    "any_error_msg": false
}

Desenvolvimento de um endpoint

• Para criar uma requisição na API do i-Educar é necessário criar ou usar uma classe Controller em modules/Api/Views/ExemploController.php;

• Essa classe deve se chamar ExemploController e herdar a classe ApiCoreController. Ex: class CursoController extends ApiCoreController

• Nessa classe deve ser reescrito o método Gerar() tratando as requisições e direcionando para métodos na api que devem implementar/retornar o objetivo da requisição.

• Verificar exemplos como a classe CursoController que auto-explica o funcionamento.