Methods

Session Management

getSession($user, $password)

• Parameters:
  • $user: User identifier.
  • $password: User password.
• Returns:
  • Establishes and returns a session for further API requests.

logout()

• Returns:
  • Revokes current session cookie.

Uncategorized/Config

getEscola()

• Returns:
  • Retrieves information about the school.

changeAnoLetivo($anoletivo)

• Parameters:
  • $anoletivo: Desired academic year in yyyy/yyyy format.
• Returns:
  • Changes the current academic year to the specified year. This change is persistent throughout sessions.

getConfInfo()

• Returns:
  • Retrieves GIAE configuration information.

Homepage Information

getPaginaInicialInfo()

• Returns:
  • Retrieves information displayed on the homepage.

getPaginaInicialMensagens()

• Returns:
  • Retrieves messages displayed on the homepage.

getAvisos()

• Returns:
  • Retrieves notices displayed on the homepage.

Meu Menu

getProcesso()

• Returns:
  • Retrieves current processes for the user.

Meu Menu -> Cartão

getSaldo()

• Returns:
  • Retrieves the user's card balance.

getMovimentosCartao($datainicial, $datafinal, $setor = "")

• Parameters:
  • $datainicial: Start date for transactions in dd-mm-yyyy format.
  • $datafinal: End date for transactions in dd-mm-yyyy format.
  • $setor: Optional parameter for filtering by sector (if not specified, returns card transactions from all sectors).
• Returns:
  • Retrieves card transactions within the specified date range and sector.

getLimitesConsumo()

• Returns:
  • Retrieves consumption limits for the user.

Meu Menu -> Avaliações

getAvaliacoes()

• Returns:
  • Retrieves assessment data for the user.

getAvaliacoesDocumentos()

• Returns:
  • Retrieves assessment documents for the user.

Meu Menu -> Caderneta

getCadernetaMensagens()

• Returns:
  • Retrieves messages from the caderneta.

getCadernetaMedidas()

• Returns:
  • Retrieves measures and absences from the caderneta.

getCadernetaOcorrencias()

• Returns:
  • Retrieves incidents from the caderneta.

Meu Menu -> Turma

getTurma()

• Returns:
  • Retrieves class information.

getProfessores()

• Returns:
  • Retrieves teachers for the class.

getDisciplinas()

• Returns:
  • Retrieves subjects for the class.

getAlunos()

• Returns:
  • Retrieves students for the class.

getHorario()

• Returns:
  • Retrieves class schedule.

getFaltas()

• Returns:
  • Retrieves absences for the user.

getSumarios($disciplina, $turma)

• Parameters:
  • $disciplina: Subject ID.
  • $turma: Class ID.
• Returns:
  • Retrieves summaries for the specified subject and class.

getTestes()

• Returns:
  • Retrieves tests for the class.

Meu Menu -> Portaria

getPortaria($datainicio, $datafim)

• Parameters:
  • $datainicio: Start date for gate records in dd-mm-yyyy format.
  • $datafim: End date for gate records in dd-mm-yyyy format.
• Returns:
  • Retrieves gate records within the specified date range.

Meu Menu -> Códigos

changePass($passAtual, $passNova)

• Parameters:
  • $passAtual: Current password.
  • $passNova: New password.
• Returns:
  • Changes the user's password.

changePin($pinAtual, $pinNovo)

• Parameters:
  • $pinAtual: Current PIN.
  • $pinNovo: New PIN.
• Returns:
  • Changes the user's PIN.

Refeições

getEmentas()

• Returns:
  • Retrieves meal menus.

getRefeicoesComprar()

• Returns:
  • Retrieves meals available for purchase.

purchaseRefeicao($ementaID)

• Parameters:
  • $ementaID: ID of the meal to be purchased.
• Returns:
  • Purchases the specified meal.

getRefeicoesServidas()

• Returns:
  • Retrieves served meals.

Escola

getHorariosAtendimento()

• Returns:
  • Retrieves office hours of the school.

getEscolaInfo()

• Returns:
  • Retrieves general information about the school.

getContactos()

• Returns:
  • Retrieves contact details of school entities for the user.

getMensagensAtivas()

• Returns:
  • Retrieves active messages from the school.

getMensagensArquivadas()

• Returns:
  • Retrieves archived messages from the school.

getPerfil()

• Returns:
  • Retrieves profile information (associated email address and full name).

Note:

• Ensure that your server supports cURL for making HTTP requests.
• Security Note: Handle user credentials and sensitive information securely, and avoid exposing them in your code or log files.