Listar Todos os Produtos

Detalhes da Rota

Rota: /Modulo/Controller/Acao/{id} 

  • Parâmetros: 
    • Id = Opcional 
  • Requer Autenticação: Sim 
  • Método: POST
  • Tipo de Retorno: List<TObjeto> | Void | TObjeto
  • Permissão
    • WinBooks.Agentes.Agente.Visualizar

Códigos de Status

  • 404 = Não Existe o TObjeto
  • 500 = Erro Interno do Servidor
  • 200 = OK 
  • 403 = Acesso Negado, Token de Autenticação Inválido?

Detalhes da Ação

Ação serve para realizar o procedimento "X" na plataforma...

Payload

Se a ação receber um conteudo "Payload", aqui deve ser descrito este conteudo, com campos e validações.

  • Content-Type: application/json
Exemplo do Payload
1
2
3
4
{
"Email": "winbooks@winbooks.com.br",
"Senha": "0806"
}

Campos e Validações

CampoDescrição / ValidaçãoValor Padrão
Email[Obrigatório] Email para a Autenticação 
Senha[Obrigatório] Senha para a Autenticação 
   

Headers

Abaixo segue os headers que devem ou podem ser passados para a ação:

HeaderDescrição / ValidaçãoValor Padrão
API_TOKEBN[Obrigatório] Token da Autenticação 
   
   

Query String

Abaixo segue os parâmetros que podem ser passados via QueryString:

HeaderDescrição / ValidaçãoValor Padrão
nome[Obrigatório] Parâmetro para a Pesquisa pelo Nome 
   
   

Detalhes do Resultado

Este é o Payload do resultado caso a ação tenha sucesso:

Exemplo do Payload
1
2
3
4
5
{
 "Codigo": 200,
 "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
 "Mensagens": null
}

Campos

CampoDescrição 
Codigo200 = Sucesso na Autenticação
TokenToken de Acesso a API
MensagensMensagens de Erro

Exemplos

Pesquisar um Atributo pelo CPF/CNPJ

/Cadastros/Agente/AtributoPara?chave=Professor.Aprovado&documento=42473060061&id=0

NomeValor
chaveProfessor.Aprovado
id0
documento42473060061

Pesquisar um Atributo pelo ID

/Cadastros/Agente/AtributoPara?chave=Professor.Aprovado&id=120

NomeValor
chaveProfessor.Aprovado
id120

 

 

Tags:
Created by WBS Tecnologia on 2020/12/28 20:24
 
WBS Tecnologia (C) 2024
1.2