Requisições MiniGestao

Índice

1 Documentação - requisições CRUD
- 1.1 Chamada
- 1.2 Get
2 Como buscar paginado no postman:
3 Escola
4 Ano
5 Pessoa
- 5.1 GetAll
  - 5.1.1 Retorno:
- 5.2 Get
  - 5.2.1 Retorno:
6 Aluno
7 Docente
8 Caderneta
9 Aula
10 CursoDisciplina
11 Disciplina
12 DocenteTurmaDisciplina
13 Turma
14 TurmaDisciplina

Documentação - requisições CRUD

(Chrome) Postman - REST Client shortcut

<Link> POST Header: Content-Type, Value: application/json

Raw – Json <send>

Chamada

tipo requisição ===Get===, GetAll

Get

===Save===, Edit, Delete POST

Como buscar paginado no postman:

<link> GET

Header Value (exemplo) Descrição Content-Type application/json cabeçalho json PageSize 2 tamanho da página. se não colocar nada, por padrão é 10. CurrentPage 0 página que será exibida. a primeira página é 0 SortField Name nome do campo do json que será ordenado o resultado. sem aspas. Case Sensitive! Diferencia maiúscula de minúscula! SortDir asc ou desc ordenação ascendente ou descendente. colocar “asc” ou “desc” sem aspas. por padrão é “asc”.

Além disso, este resultado retorna via response, mais alguns headers, em especial 2 campos:

Header Value (exemplo) Descrição TotalPages 7 Total de páginas que essa busca possui, baseado no tamanho da página e contagem de registros. X-RecordsCount 19 Total de registros da página.

Escola

GetAll

http://localhost:52439/Escola/GetAll

Retorno:

http://pastebin.com/YN5LHScH

Get

http://localhost:52439/Escola/Get?id=1

Retorno:

http://pastebin.com/rVW5iicC

GetByDocente

http://localhost:52439/Escola/GetByDocente?pes_id=df97ba73-762e-e611-80c9-00155d000d82

Retorno:

http://pastebin.com/7L0zjHpj

Save

http://localhost:52439/Escola/Save

Entrada:

http://pastebin.com/qn2we6Zg

Retorno:

http://pastebin.com/BaZvYbe4

Ano

Get

http://localhost:52439/Ano/GetAll http://pastebin.com/g2tBHFNn

GetAll

http://localhost:52439/Ano/Get?id=20 http://pastebin.com/Zdhh858P

Save

http://localhost:52439/Ano/Save

Entrada:

http://pastebin.com/AUqXGM2Z

Retorno:

http://pastebin.com/ix9Wd49H

Edit

http://localhost:52439/Ano/Edit

Entrada:

http://pastebin.com/PShwpPxq

Delete

http://localhost:52439/Ano/Delete?id=10

Pessoa

GetAll

http://localhost:52439/Pessoa/GetAll

Retorno:

http://pastebin.com/yUNpYfPX

Get

busca dados da pessoa + usuário do Core passando o pes_id (Guid):

http://localhost:52439/Pessoa/Get?pes_id=772c60e0-bcdf-e511-80bf-e894f602060a

Retorno:

http://pastebin.com/FXb4LYKG

Aluno

GetAll

http://localhost:52439/Aluno/GetAll

Retorno:

http://pastebin.com/qYkFN8zC

Obs: Traz sem os dados de Responsável para diminuir a carga do banco

Get

busca pelo ID do banco do mini-gestão (AlunoId: int) http://localhost:52439/Aluno/Get?id=4

Retorno:

http://pastebin.com/sW46sZ0Q

GetByTurma

http://localhost:52439/Aluno/GetByTurma?id=1

Retorno:

http://pastebin.com/m39EgUet

GetByCoreSSO

busca aluno tanto pelo pes_id quanto pelo usu_id, ambos são opcionais, mas pelo menos 1 precisa ser obrigatório para retornar um resultado:

(por usu_id_coresso) http://localhost:52439/Aluno/GetByCoreSSO?usu_id=4cbe2fa1-452f-e611-80c9-00155d000d82

(por pes_id_coresso) http://localhost:52439/Aluno/GetByCoreSSO?pes_id=b32daff9-732e-e611-80c9-00155d000d82

Retorno:

http://pastebin.com/RaaFEuEd

Save

cria novo aluno, retornando os id’s do mesmo http://localhost:52439/Aluno/Save

Entrada:

http://pastebin.com/7muwer6b

Retorno:

http://pastebin.com/vRc0j93e

Edit

===Edit===a sem retorno http://localhost:52439/Aluno/Edit

Entrada:

http://pastebin.com/tYQyUPBa

Delete

http://localhost:52439/Aluno/Delete?id=3

Docente

GetAll

http://localhost:52439/Docente/GetAll

Retorno:

http://pastebin.com/Bqfi7Jhp

Get

Busca pelo ID do miniGestão (docenteId : int)

http://localhost:52439/Docente/Get?id=3

GetByTurma

http://localhost:52439/Docente/GetByTurma?id=1

Retorno:

http://pastebin.com/BzmSSNHW

GetByCoreSSO

busca docente tanto pelo pes_id quanto pelo usu_id, ambos são opcionais, mas pelo menos 1 precisa ser obrigatório para retornar um resultado:

(por usu_id_coresso) http://localhost:52439/Docente/getByCoreSSO?usu_id=e757577e-762e-e611-80c9-00155d000d82

(por pes_id_coresso) http://localhost:52439/Docente/getByCoreSSO?pes_id=e657577e-762e-e611-80c9-00155d000d82

Retorno:

http://pastebin.com/UnCmUv2F

Save

cria novo aluno, retornando os id’s do mesmo

http://localhost:52439/Docente/Save

Entrada:

http://pastebin.com/zgeiH0EN

Retorno:

http://pastebin.com/R0PAYzb6

Edit

===Edit===a sem retorno http://localhost:52439/Docente/Edit

Entrada:

http://pastebin.com/feunYBkZ

Delete

http://localhost:52439/docente/Delete?id=1

Caderneta

GetAll

http://localhost:52439/caderneta/getall

Retorno:

http://pastebin.com/nPdcmGuM

Get

http://localhost:52439/caderneta/get?id=2

Retorno:

http://pastebin.com/PgyGsEVa

Save

http://localhost:52439/caderneta/save

Entrada:

http://pastebin.com/Kc0GNUpL

Retorno:

http://pastebin.com/fsJYytgy

Observação: caso seja enviado um id da chave primária que já existe no banco, não é cadastrado nada e o método retorna a mesma coisa que veio na requisição.

Caso este ID não exista, é chamado o método de gravação, que grava o registro, caso este não tenha a mesma combinação de chave estrangeira no BD.

Edit

http://localhost:52439/caderneta/edit

Entrada:

http://pastebin.com/wWu3n9ZD

Delete

http://localhost:52439/caderneta/delete?id=1

Aula

GetAll

http://localhost:52439/aula/getall

Retorno:

http://pastebin.com/659YXvgV

Get

http://localhost:52439/aula/get?id=2005

Retorno:

http://pastebin.com/gwQyh48A

Save

http://localhost:52439/aula/save

Entrada:

http://pastebin.com/t6x9HQrx saída: http://pastebin.com/sTZ5sX4K

Observação: caso seja enviado um json com um ID que já existe no banco, não é cadastrado nada, e retorna o mesmo json da requisição.

Caso seja enviado um json com um id que não existe, é cadastrada uma nova aula, com um novo ID (que não necessariamente é o ID que veio na requisição), e retornado o novo registro com o novo ID.