MyEscola

Método Json

API Base de conhecimento

Lista de sumários pelo método Json
https://www.myescola.pt/api/sumariosnet

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 data_sum 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_sum int 0 1 vazio Estado do sumário relativamente à intergração no software
  • 0 [Não integado]
  • 1 [Integrado]
turma_sum char(6) Filtrar por turma do sumário
disc_sum char(6) Filtrar por disciplina do sumário
data_sum decimal(16,6) Filtrar por data do sumário (Ex: 19010101)
hora_sum char(5) Filtrar por hora do sumário
* 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["turma_sum"] char(6) Código da turma
   rows["disc_sum"] char(6) Código da disciplina
   rows["data_sum"] decimal(16,6) Data do sumário
   rows["hora_sum"] char(5) Hora do sumário
   rows["sumario_sum"] text Sumário
   rows["prof_sum"] int(11) Código do professor que registou o sumário
   rows["opcao1_sum"] char(30) Número do sumário
   rows["integrado_sum"] int(1) Registo integrado no software
  • 0 [Não integado]
  • 1 [Integrado]
Exemplo
$data["privatekey"] = "CHAVE_PRIVADA_DA_EMPRESA";
$data["integrado_sum"] = 0;

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

//submeter o webservice por CURL
$curl = curl_init("https://www.myescola.pt/api/sumariosnet");
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