MyEscola

Método Json

API Base de conhecimento

Lista de candidaturas pelo método Json
https://www.myescola.pt/api/candidaturasnet

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(30) cod_preins Nome do campo da tabela (Consultar campos disponíveis no array rows da tabela abaixo)
order_sort char(4) asc Tipo de ordenação ascendente
  • asc [Asendente]
  • desc [Descendente]
act_preins array() Estado da candidatura
  • "n" [Pendente]
  • "s" [Análise]
  • "a" [Aceite]
  • "p" [Análise Matrícula]
  • "m" [Matriculado]
  • "r" [Rejeitado]
  • "t" [Rejeitado Transferência]
recibo_preins bolean Com/Sem Recibo
  • "0" [Sem ID de Recibo]
  • "1" [Com ID de Recibo]
* Parâmetros 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
Exemplo
$data["privatekey"] = "CHAVE_PRIVADA_DA_EMPRESA";

$data["act_preins"] = array("n","m");

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

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