Secretários(as)
Secretários(as) são usuários da escola com permissões administrativas (matrículas, frequência, documentos). Cada secretário(a) possui uma conta de usuário e um perfil.
O modelo secretário(a)
id
uuid
Identificador do usuário.
email
string
E-mail de acesso.
name
string
Nome completo.
birthdate
date|null
Data de nascimento (YYYY-MM-DD).
role
string
Sempre "secretary".
school_cnpj
string
CNPJ da escola.
Modelo secretário(a)
{ "id": "...", "email": "sec@escola.com", "name": "Ana Souza", "role": "secretary" }
GET
/v1/partners/school/{cnpj}/secretaries/all
Listar Secretários
Lista todos os secretários da escola.
Parâmetros de rota
cnpj
string
obrigatório
CNPJ da escola (14 dígitos, sem formatação).
Códigos de resposta
200
Sucesso.
401
Autenticação inválida.
404
Escola ou recurso não encontrado.
Requisição
GET
GET
/v1/partners/school/{cnpj}/secretaries/all
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/secretaries/all \-H "X-Authorization: {api_token}" \
-H "X-Partner: {partner_token}" \
-H "X-Client: {client_slug}"
$client->get('.../v1/partners/school/{cnpj}/secretaries/all');
await fetch('.../v1/partners/school/{cnpj}/secretaries/all');
Resposta
{ "data": [ { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "email": "ana.paula@escola.com.br", "name": "Ana Paula Souza", "birthdate": "1990-03-14", "role": "secretary", "school_cnpj": "26019466000122" } ], "links": { /* paginação */ }, "meta": { /* paginação */ } }
{ "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client." }
{ "message": "Escola ou recurso não encontrado." }
GET
/v1/partners/school/{cnpj}/secretary/{id}
Obter Secretário
Retorna um secretário pelo UUID.
Parâmetros de rota
cnpj
string
obrigatório
CNPJ da escola (14 dígitos, sem formatação).
id
uuid
obrigatório
UUID do secretário.
Códigos de resposta
200
Sucesso.
401
Autenticação inválida.
404
Escola ou recurso não encontrado.
Requisição
GET
GET
/v1/partners/school/{cnpj}/secretary/{id}
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/secretary/{id} \-H "X-Authorization: {api_token}" \
-H "X-Partner: {partner_token}" \
-H "X-Client: {client_slug}"
$client->get('.../v1/partners/school/{cnpj}/secretary/{id}');
await fetch('.../v1/partners/school/{cnpj}/secretary/{id}');
Resposta
{ "data": { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "email": "ana.paula@escola.com.br", "name": "Ana Paula Souza", "birthdate": "1990-03-14", "role": "secretary", "school_cnpj": "26019466000122" } }
{ "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client." }
{ "message": "Escola ou recurso não encontrado." }
POST
/v1/partners/school/{cnpj}/secretary
Criar Secretário
Cria um secretário.
Parâmetros de rota
cnpj
string
obrigatório
CNPJ da escola (14 dígitos, sem formatação).
Parâmetros do corpo
name
string
obrigatório
Nome completo.
email
string
obrigatório
E-mail único na plataforma.
birthdate
date
opcional
Data de nascimento (YYYY-MM-DD).
Códigos de resposta
201
Recurso criado com sucesso.
400
Dados inválidos.
401
Autenticação inválida.
404
Escola ou recurso não encontrado.
Requisição
POST
POST
/v1/partners/school/{cnpj}/secretary
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/secretary \-X POST \
-H "X-Authorization: {api_token}" \
-H "X-Partner: {partner_token}" \
-H "X-Client: {client_slug}" \
-H "Content-Type: application/json" \
-d '{ "name"*: "...", "email"*: "...", "birthdate": "..." }'
$client->post('.../v1/partners/school/{cnpj}/secretary', ['json' => [/* ... */]]);
await fetch('.../v1/partners/school/{cnpj}/secretary', {
method: 'POST',
body: JSON.stringify({/* ... */})
});
Resposta
{ "data": { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "email": "ana.paula@escola.com.br", "name": "Ana Paula Souza", "birthdate": "1990-03-14", "role": "secretary", "school_cnpj": "26019466000122" } }
{ "message": "Os dados fornecidos são inválidos.", "errors": { "name": ["O campo nome é obrigatório."] } }
{ "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client." }
{ "message": "Escola ou recurso não encontrado." }
PUT
/v1/partners/school/{cnpj}/secretary/{id}
Editar Secretário
Atualiza um secretário.
Parâmetros de rota
cnpj
string
obrigatório
CNPJ da escola (14 dígitos, sem formatação).
id
uuid
obrigatório
UUID do secretário.
Parâmetros do corpo
name
string
opcional
Nome completo.
email
string
opcional
Novo e-mail.
birthdate
date
opcional
Data de nascimento (YYYY-MM-DD).
Códigos de resposta
200
Sucesso.
400
Dados inválidos.
401
Autenticação inválida.
404
Escola ou recurso não encontrado.
Requisição
PUT
PUT
/v1/partners/school/{cnpj}/secretary/{id}
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/secretary/{id} \-X PUT \
-H "X-Authorization: {api_token}" \
-H "X-Partner: {partner_token}" \
-H "X-Client: {client_slug}" \
-H "Content-Type: application/json" \
-d '{ "name": "...", "email": "...", "birthdate": "..." }'
$client->put('.../v1/partners/school/{cnpj}/secretary/{id}', ['json' => [/* ... */]]);
await fetch('.../v1/partners/school/{cnpj}/secretary/{id}', {
method: 'PUT',
body: JSON.stringify({/* ... */})
});
Resposta
{ "data": { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "email": "ana.paula@escola.com.br", "name": "Ana Paula Souza", "birthdate": "1990-03-14", "role": "secretary", "school_cnpj": "26019466000122" } }
{ "message": "Os dados fornecidos são inválidos.", "errors": { "name": ["O campo nome é obrigatório."] } }
{ "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client." }
{ "message": "Escola ou recurso não encontrado." }
DELETE
/v1/partners/school/{cnpj}/secretary/{id}
Excluir Secretário
Remove um secretário.
Parâmetros de rota
cnpj
string
obrigatório
CNPJ da escola (14 dígitos, sem formatação).
id
uuid
obrigatório
UUID do secretário.
Códigos de resposta
200
Sucesso.
401
Autenticação inválida.
404
Escola ou recurso não encontrado.
Requisição
DELETE
DELETE
/v1/partners/school/{cnpj}/secretary/{id}
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/secretary/{id} \-X DELETE \
-H "X-Authorization: {api_token}" \
-H "X-Partner: {partner_token}" \
-H "X-Client: {client_slug}"
$client->delete('.../v1/partners/school/{cnpj}/secretary/{id}');
await fetch('.../v1/partners/school/{cnpj}/secretary/{id}', {
method: 'DELETE'
});
Resposta
{ "message": "Recurso removido com sucesso." }
{ "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client." }
{ "message": "Escola ou recurso não encontrado." }