Wiki source code of Produtos - Estoque Desde
Last modified by WBS Tecnologia on 2021/06/11 21:39
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="jumbotron" %) | ||
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
5 | = Listar Produtos com Estoque Atualizado Desde = | ||
6 | ))) | ||
7 | ))) | ||
8 | |||
9 | (% class="row" %) | ||
10 | ((( | ||
11 | (% class="col-xs-12 col-sm-8" %) | ||
12 | ((( | ||
13 | = Detalhes da Rota = | ||
14 | |||
15 | (% class="box infomessage" %) | ||
16 | ((( | ||
17 | Rota: /BDIApi/Produto/EstoqueDesde?horas=X | ||
18 | ))) | ||
19 | |||
20 | * Parâmetros: | ||
21 | ** horas = [Obrigatório] Tem que ser maior que 0. | ||
22 | ** tipo = [Opcional] Quantidade a Ser Considerada | ||
23 | * Requer Autenticação: **Sim ** | ||
24 | * Método: **GET** | ||
25 | * Tipo de Retorno**: List<Produto> | Void | Produto** | ||
26 | * Headers: | ||
27 | ** API_TOKEN: Token de Autenticação | ||
28 | |||
29 | == Códigos de Status == | ||
30 | |||
31 | * 404 = Sem resultados | ||
32 | * 500 = Erro Interno do Servidor | ||
33 | * 200 = OK | ||
34 | * 403 = Acesso Negado, Token de Autenticação Inválido? | ||
35 | |||
36 | = Detalhes da Ação = | ||
37 | |||
38 | Realiza a Listagem Resumida dos produtos que sofreram mudança de estoque no Catálogo apartir da ultimas X horas indicadas. | ||
39 | |||
40 | === (% style="font-size:26px" %)Query String(%%) === | ||
41 | |||
42 | Abaixo segue os headers que devem ou podem ser passados para a ação: | ||
43 | |||
44 | (% style="height:74px; width:841px" %) | ||
45 | |=Param|=Descrição / Validação | ||
46 | |horas|((( | ||
47 | [Obrigatório] Este numero será a Data e Hora atual menos o número indicado. | ||
48 | ))) | ||
49 | |tipo|[Opcional] Dever ser **"h"** para horas ou **"m"** para minutos | ||
50 | |||
51 | === (% style="font-size:26px" %)Headers(%%) === | ||
52 | |||
53 | Abaixo segue os headers que devem ou podem ser passados para a ação: | ||
54 | |||
55 | |=Header|=Descrição / Validação|=Valor Padrão | ||
56 | |API_TOKEN|[Obrigatório] Token da Autenticação| | ||
57 | |||
58 | == (% style="font-size:29px" %)Detalhes do Resultado(%%) == | ||
59 | |||
60 | Este é o Payload do resultado caso a ação tenha sucesso: | ||
61 | |||
62 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
63 | [ | ||
64 | { | ||
65 | "CodigoDeBarras": "9788577531912", | ||
66 | "Estoque": 1, | ||
67 | "Preco": 59.90, | ||
68 | "Situacao": 0, | ||
69 | "Id": 143758, | ||
70 | "Versao": null | ||
71 | }, | ||
72 | ... | ||
73 | {{/code}} | ||
74 | |||
75 | == Exemplos == | ||
76 | |||
77 | **GET /EstoqueDesde?horas=2** | ||
78 | |||
79 | Retorna os produtos que sofreram mudança de estoque nas ultimas 2 horas | ||
80 | |||
81 | **GET /EstoqueDesde?horas=15&tipo=m** | ||
82 | |||
83 | Retorna os produtos que sofreram mudança de estoque nos últimos 15 minutos. | ||
84 | |||
85 | == Observações == | ||
86 | |||
87 | * Grandes períodos informados podem recuperar grandes volumes de informação, isso pode gerar Payloads grandes no resultado e afetar a performance geral. | ||
88 | ))) | ||
89 | |||
90 | |||
91 | |||
92 | (% class="col-xs-12 col-sm-4" %) | ||
93 | ((( | ||
94 | {{box title="**Índice**"}} | ||
95 | {{toc/}} | ||
96 | {{/box}} | ||
97 | |||
98 | {{box}} | ||
99 | **Exemplos** | ||
100 | |||
101 | * Exemplo de Payload: BAIXAR | ||
102 | * Exemplo de Resultado: BAIXAR | ||
103 | {{/box}} | ||
104 | ))) | ||
105 | ))) |