Skip to content

api.md

Latest commit

 

History

History
143 lines (98 loc) · 2.03 KB

api.md

File metadata and controls

143 lines (98 loc) · 2.03 KB

URL Base

http://localhost:8080/api

Headers Padrão

Content-Type: application/json

Rotas: Registration

Create Registration

Method: POST
Endpoint: /registration/create

Request

{
  "name": "Usuário Teste",
  "email": "usuario@teste.com",
  "birth_date": "2001-01-01",
  "registration_number": "01234567890"
}

Descrição: Adiciona um novo registro. Todos os dados são obrigatórios.

Update Registration

Method: POST
Endpoint: /registration/update

Request

{
  "id": "1",
  "name": "Usuário X Teste",
  "email": "usuariox@teste.com",
  "birth_date": "2002-02-02",
  "registration_number": "123.456.789-09"
}

Descrição: Atualiza um registro com base em seu ID. Pode passar apenas os dados que realmente deseja que sejam alterados.

Find Registration

Method: POST
Endpoint: /registration/find

Request

{
  "id": "1"
}

Descrição: Retorna um registro com base em seu ID.

List Registrations

Method: POST
Endpoint: /registration/list

Request

{
  "page": 1,
  "per_page": 1,
  "name": null,
  "search_name": null,
  "email": null,
  "search_email": null,
  "birth_date": null
}

Descrição: Retorna uma lista de registros com base nos filtros informados.

Filtros

  • page : Página atual
  • per_page : Itens por página
  • name : Filtro exato por nome
  • search_name : Busca parcial por nome
  • email : Filtro exato por email
  • search_email : Busca parcial por email
  • birth_date : Filtro por data de nascimento

Delete Registration

Method: POST
Endpoint: /registration/delete

Request

{
  "id": "1"
}

Descrição: Remove um registro com base em seu ID.

Export Registrations

Method: POST
Endpoint: /registration/export

Request

{
  "id": null,
  "registration_number": "01234567890"
}

Descrição: Exporta registro de acordo com ID ou Documento informado.