MyEscola

Método Json

API Base de conhecimento

Lista de faltas pelo método Json
https://www.myescola.pt/api/faltasalunosnet

Parâmetros
Parâmetro Valores Defeito Descrição
privatekey * CHAVE_DA_ESCOLA Obrigatório Chave de identificação do estabelecimento de ensino fornecida pela Wincode
limit int 1000 Limite de registos por serviço
curpage int 1 Página atual
order_by char dat_fala Nome do campo da tabela (Consultar campos disponíveis no array rows da tabela abaixo)
order_sort char asc desc asc Tipo de ordenação ascendente
  • asc [Asendente]
  • desc [Descendente]
integrado_fala int 0 1 Estado da falta relativamente à intergração no software
  • 0 [Não integado]
  • 1 [Integrado]
mat_fala decimal(16,6) Filtrar por matricula
dat_fala decimal(16,6) Filtrar por data (Ex: 19010101)
hor_fala char(5) Filtrar por hora
disc_fala char(6) Filtrar por disciplina
* Parametros obrigatórios a enviar
Variáveis de Retorno
Nome Tipo Descrição
status Boolean Retorno do serviço true ou false
message string Mensagem com o resultado do serviço
count int Quantidade de registos por query/página
count_total int Quantidade total de registos encontrados
offset int Offset dos registos
rows array Array de registos retornados
   rows["mat_fala"] decimal(16,6) Matricula do Aluno
   rows["dat_fala"] decimal(16,6) Data
   rows["hor_fala"] char(5) Hora
   rows["disc_fala"] char(6) Disciplina
   rows["per_fala"] char(6) Período
   rows["tipo_fala"] char(6) Tipo de falta
   rows["dat_just_fala "] decimal(16,6) Data de justificação
   rows["motivo_fala"] text Descritivo
   rows["op_just_fala"] char(6) Opção de justificação
   rows["obs_fala"] char(50) Observações
   rows["turma_fala"] char(6) Turma
   rows["integrado_fala"] int(1) Registo integrado no software
  • 0 [Não integado]
  • 1 [Integrado]
Exemplo
$data["privatekey"] = "CHAVE_PRIVADA_DA_EMPRESA";

//transformar data do $_POST para JSON
$content = json_encode($data);

//submeter o webservice por CURL
$curl = curl_init("https://www.myescola.pt/api/faltasalunosnet");
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $content);

$json_response = curl_exec($curl);

$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);

curl_close($curl);

//resposta do webservice
$response = json_decode($json_response, true);

echo $response["message"];

Formulário para testes