Mais informações referente aos métodos disponíveis

Métodos HTTPS (RestAPI)

Métodos

Descrição

[GET]

  • busca uma lista de registros
  • busca um registro em específico

[POST]

  • insere novos registros

[PUT]

  • edita registros

[DELETE]

  • deleta registros

A maioria dos métodos [GET] recebe parâmetros opcionais na URL

Parâmetro

Objetivo

id

Código identificador do registro.
Deve ser utilizado quando se deseja obter um registro em específico.
Pode-se utilizar o padrão "?id=100" ou "/100".

pageSize

Número de registros por página.
mínimo – 1; máximo – 100; padrão - 15;

pageIndex

Índice da página que se deseja retornar os registros.
mínimo – 0; máximo - sem limite; padrão - 0;

query

Campo de texto para uma busca geral.
Exemplo: em contas a busca geral é aplicada sobre os campos nome, nome completo, e-mail principal e telefone principal.

filter

Objeto JSON referente à uma busca e ordenação mais avançada.