MyEscola

Método Json

API Base de conhecimento

Atualização de candidaturas pelo método Json
https://www.myescola.pt/api/candidaturasnetupdate

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
Update WHERE IN
primkeyarray array Array de chaves primárias. Cada chave primária deve obrigatóriamente ser composta por ins_preins
Update SET
set_integrado_preins int Marcar o registo como integrado no software
  • 0 [Não integrado]
  • 1 [Integrado]
set_act_preins char(1) Alterar o estado da candidatura
  • "n" [Pendente]
  • "s" [Análise]
  • "a" [Aceite]
  • "p" [Análise Matrícula]
  • "m" [Matriculado]
  • "r" [Rejeitado]
* 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
affected_rows int Quantidade de linhas afetadas pelo update
Exemplo
$data["privatekey"] = "CHAVE_PRIVADA_DA_EMPRESA";
$data["set_integrado_preins"] = 1;
$data["primkeyarray"] = array("01","02","03"); //Códigos de pré-inscricao [ins_preins]

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

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