05/07/2022

Consultar Turmas do Aluno

Route (Rota)

Método	Rota	Descrição
GET	`/webservice/student/classrooms`	Retorna o aluno e as turmas vinculadas a ele

Headers (Cabeçalho)

Param	Tipo	Descrição	Obrigatório
content-type	`String`	application/json	Sim
secret	`String`	*Secret Key	Sim
token	`String`	**Webservice Token	Sim

*Para conseguir a Secret Key acesse sua Plataforma, abra o Menu, vá na área de Usuários e acesse Webservice, lá você terá a lista de usuários com suas respectivas Secret Key

** Token gerado pela rota de autenticação

Query params (Parâmetros)

Param	Tipo	Descrição	Obrigatório
student_id	`String`	Id do aluno	Não
document_type	`String`	*Tipo de documento - Ex.: CPF	Não
document	`String`	**Documento do aluno - Ex.: XXX.XXX.XXX-XX	Não
filter	`JSON`	JSON com filtros a serem aplicados as turmas do aluno	Não
field_name	`String`		Não
field_value	`String`		Não

* Os tipos de documento padrão da plataforma são: CPF, RG e CNPJ

Exemplos

cURL

				
					curl --location 'https://sua.plataforma.com/student/classrooms?document=1&document_type=rg' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_sercret}}' \
--header 'token: {{._webservice_token}}'

Node.js

				
					const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://sua.plataforma.com/student/classrooms?document=1&document_type=rg',
  headers: { 
    'Accept': 'application/json', 
    'secret': '{{._webservice_sercret}}', 
    'token': '{{._webservice_token}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP

				
					<?php
$client = new Client();
$headers = [
  'Accept' => 'application/json',
  'secret' => '{{._webservice_sercret}}',
  'token' => '{{._webservice_token}}'
];
$request = new Request('GET', 'https://sua.plataforma.com/student/classrooms?document=1&document_type=rg', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Response (Respostas)

- Aluno encontrado (Status: 200)

				
					{
    "message": "Encontrado",
    "status": "200",
    "data": {
        "student": {
            "id": "1",
            "document_type": "CPF",
            "document": "999.999.999-99",
            "geographic_lock": "0",
            "profile": {
                "instagram": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "website": null,
                "picture": null
            },
            "user": {
                "name": "User",
                "email": "email@email.com",
                "expires_at": null
            },
            "secondaries": [],
            "form": null
        },
        "classrooms": [
            {
                "id": "1",
                "status": "1",
                "author": {
                    "id": "1",
                    "name": "author",
                    "email": "author@nochalks.com",
                    "email_verified_at": null,
                    "language": "br",
                    "provider": null,
                    "provider_id": null,
                    "status": "1",
                    "created_at": "2022-03-30 13:21:30",
                    "updated_at": "2022-03-30 13:22:29",
                    "expires_at": null,
                    "old_password": null,
                    "has_api": "0"
                },
                "translation": {
                    "name": "Turma",
                    "description": "<p>Turma de Teste<\/p>",
                    "language_id": "1"
                }
            }
        ]
    }
}

Tags:

← Anterior