From version 1.1 >
edited by WBS Tecnologia
on 2020/12/28 20:06
To version < 7.1 >
edited by WBS Tecnologia
on 2021/01/08 16:04
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Produtos - Todos
1 +Produtos - Desconto para um Produto (Cód. de Barras)
Content
... ... @@ -2,7 +2,7 @@
2 2  (((
3 3  (% class="container" %)
4 4  (((
5 -= Listar Todos os Produtos =
5 += Listar Produtos com Estoque Atualizado Desde =
6 6  )))
7 7  )))
8 8  
... ... @@ -14,20 +14,20 @@
14 14  
15 15  (% class="box infomessage" %)
16 16  (((
17 -Rota: /Modulo/Controller/Acao/{id}
17 +Rota: /BDIApi/Desconto/Para?codigo=XXXXXXX
18 18  )))
19 19  
20 20  * Parâmetros: 
21 -** Id = //Opcional //
21 +** codigo = [Obrigatório] Código de Barras do Produto
22 22  * Requer Autenticação: **Sim **
23 -* Método: **POST**
24 -* Tipo de Retorno**: List<TObjeto> | Void | TObjeto**
25 -* Permissão**: **
26 -** WinBooks.Agentes.Agente.Visualizar
23 +* Método: **GET**
24 +* Tipo de Retorno**:  Void | Desconto**
25 +* Headers:
26 +** API_TOKEN: Token de Autenticação
27 27  
28 28  == Códigos de Status ==
29 29  
30 -* 404 = Não Existe o TObjeto
30 +* 404 = Sem resultados
31 31  * 500 = Erro Interno do Servidor
32 32  * 200 = OK
33 33  * 403 = Acesso Negado, Token de Autenticação Inválido?
... ... @@ -34,85 +34,31 @@
34 34  
35 35  = Detalhes da Ação =
36 36  
37 -Ação serve para realizar o procedimento "X" na plataforma...
37 +Consulta o Desconto para uma Produto Especifico.
38 38  
39 -== Payload ==
39 +=== (% style="font-size:26px" %)Headers(%%) ===
40 40  
41 -Se a ação receber um conteudo "Payload", aqui deve ser descrito este conteudo, com campos e validações.
42 -
43 -* Content-Type: application/json
44 -
45 -{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
46 -{
47 - "Email": "winbooks@winbooks.com.br",
48 - "Senha": "0806"
49 -}
50 -{{/code}}
51 -
52 -=== Campos e Validações ===
53 -
54 -|=Campo|=Descrição / Validação|=Valor Padrão
55 -|Email|[Obrigatório] Email para a Autenticação|
56 -|Senha|[Obrigatório] Senha para a Autenticação|
57 -| | |
58 -
59 -== Headers ==
60 -
61 61  Abaixo segue os headers que devem ou podem ser passados para a ação:
62 62  
63 63  |=Header|=Descrição / Validação|=Valor Padrão
64 -|API_TOKEBN|[Obrigatório] Token da Autenticação|
65 -| | |
66 -| | |
44 +|API_TOKEN|[Obrigatório] Token da Autenticação|
67 67  
68 -== Query String ==
46 +== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
69 69  
70 -Abaixo segue os parâmetros que podem ser passados via QueryString:
71 -
72 -|=Header|=Descrição / Validação|=Valor Padrão
73 -|nome|[Obrigatório] Parâmetro para a Pesquisa pelo Nome|
74 -| | |
75 -| | |
76 -
77 -= Detalhes do Resultado =
78 -
79 79  Este é o Payload do resultado caso a ação tenha sucesso:
80 80  
81 81  {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
82 82  {
83 - "Codigo": 200,
84 - "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
85 - "Mensagens": null
52 + "Id": 1,
53 + "IDProduto": 163936,
54 + "PrecoDeVenda": 25.60,
55 + "PrecoDeConsignacao": 21.30,
56 + "DescontoDeVenda": 10.0000000,
57 + "DescontoDeConsignacao": 10.0000000,
58 + "AtualizadoEm": null,
59 + "CodigoDeBarras": "9788575421284"
86 86  }
87 87  {{/code}}
88 -
89 -== Campos ==
90 -
91 -|=Campo|=Descrição
92 -|Codigo|200 = Sucesso na Autenticação
93 -|Token|Token de Acesso a API
94 -|Mensagens|Mensagens de Erro
95 -
96 -= Exemplos =
97 -
98 -== Pesquisar um Atributo pelo CPF/CNPJ ==
99 -
100 -/Cadastros/Agente/AtributoPara?chave=Professor.Aprovado&documento=42473060061&id=0
101 -
102 -|=Nome|=Valor
103 -|chave|Professor.Aprovado
104 -|id|0
105 -|documento|42473060061
106 -
107 -== Pesquisar um Atributo pelo ID ==
108 -
109 -/Cadastros/Agente/AtributoPara?chave=Professor.Aprovado&id=120
110 -
111 -|=Nome|=Valor
112 -|chave|Professor.Aprovado
113 -|id|120
114 -
115 -
116 116  )))
117 117  
118 118  
... ... @@ -130,5 +130,3 @@
130 130  {{/box}}
131 131  )))
132 132  )))
133 -
134 -
WBS Tecnologia (C) 2024
1.2