Last modified by WBS Tecnologia on 2021/10/04 12:05
From version < 3.1 >
edited by WBS Tecnologia
on 2020/12/28 20:23
To version 1.1 >
edited by WBS Tecnologia
on 2020/12/28 20:06
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Produtos - Últimos Atualizados Em
1 +Produtos - Todos
Content
... ... @@ -14,21 +14,20 @@
14 14  
15 15  (% class="box infomessage" %)
16 16  (((
17 -Rota: /BDIApi/Produto/TodosDesde?horas=X
17 +Rota: /Modulo/Controller/Acao/{id}
18 18  )))
19 19  
20 20  * Parâmetros: 
21 -** horas = [Obrigatório] Tem que ser maior que 0.
21 +** Id = //Opcional //
22 22  * Requer Autenticação: **Sim **
23 -* Método: **GET**
24 -* Tipo de Retorno**: List<Produto> | Void | Produto**
25 -* Headers:
26 -** API_TOKEN: Token de Autenticação
27 -** Parametros de [[Paginação>>doc:Web Rest API.Paginação.WebHome]]
23 +* Método: **POST**
24 +* Tipo de Retorno**: List<TObjeto> | Void | TObjeto**
25 +* Permissão**: **
26 +** WinBooks.Agentes.Agente.Visualizar
28 28  
29 29  == Códigos de Status ==
30 30  
31 -* 404 = Sem resultados
30 +* 404 = Não Existe o TObjeto
32 32  * 500 = Erro Interno do Servidor
33 33  * 200 = OK
34 34  * 403 = Acesso Negado, Token de Autenticação Inválido?
... ... @@ -35,74 +35,85 @@
35 35  
36 36  = Detalhes da Ação =
37 37  
38 -Realiza a Listagem de Todos os Produtos no Catálogo que foram atualizados nas ultimas X horas indicadas.
37 +Ação serve para realizar o procedimento "X" na plataforma...
39 39  
40 -=== (% style="font-size:26px" %)Headers(%%) ===
39 +== Payload ==
41 41  
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 +
42 42  Abaixo segue os headers que devem ou podem ser passados para a ação:
43 43  
44 44  |=Header|=Descrição / Validação|=Valor Padrão
45 -|API_TOKEN|[Obrigatório] Token da Autenticação|
64 +|API_TOKEBN|[Obrigatório] Token da Autenticação|
65 +| | |
66 +| | |
46 46  
47 -== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
68 +== Query String ==
48 48  
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 +
49 49  Este é o Payload do resultado caso a ação tenha sucesso:
50 50  
51 51  {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
52 -[
53 - {
54 - "Estoque": 0,
55 - "Preco": 16.50,
56 - "Situacao": 0,
57 - "Edicao": "",
58 - "EstoqueMinimo": 0,
59 - "Resenha": "A paz reina há mais de 1000 anos em Orbis, o vasto Império Galático Romano. Mas, de repente, surge uma terrível ameaça- os Hunos pilharam Aquincum, um planeta provincial. O Imperador reúne suas legiões, mas o destino parece estar contra ele, que morre antes mesmo da guerra ter início. Orbis cede aos bárbaros e abandona Aquincum, aceitando entregar 12 jovens como sacrifício a Kerka, a deusa do Caos venerada pelos Hunos. No meio dos gritos eufóricos dos bárbaros, os jovens são degolados no altar-mor do grande templo. Então, acontece um milagre- Kerka está de volta. 'Flagelo dos Deuses' é uma livre adaptação do confronto entre o rei huno Átila e o general romano Flavius Aetius.",
60 - "Visivel": true,
61 - "NumeroDePaginas": 48,
62 - "Peso": 0.276000,
63 - "Formato": "23x30 ",
64 - "Lombada": "0.3 ",
65 - "Acabamento": " ",
66 - "Categorias": [
67 - "HQs e Mangás",
68 - "",
69 - ""
70 - ],
71 - "UrlDaCapa": "",
72 - "Autores": [
73 - {
74 - "Nome": "DIVERSOS ",
75 - "Biografia": "",
76 - "UrlDaFoto": "",
77 - "Id": 31671,
78 - "Versao": null
79 - }
80 - ],
81 - "Editora": "DEVIR ",
82 - "ValorEBook": 0.00,
83 - "PedacoDoLivro": "",
84 - "PalavrasChave": "",
85 - "Traducao": "",
86 - "Descricao": "Flagelo dos Deuses, O",
87 - "Subtitulo": null,
88 - "LancadoEm": "0001-01-01T00:00:00",
89 - "PublicadoEm": null,
90 - "AtualizadoEm": null,
91 - "CodigoDeBarras": "9728631626",
92 - "StatusId": 0,
93 - "EmpresaId": null,
94 - "GrupoId": null,
95 - "TipoId": null,
96 - "CriadoEm": "2019-09-10T09:38:10.053",
97 - "Id": 185244,
98 - "Versao": null
99 - },
100 -...
82 +{
83 + "Codigo": 200,
84 + "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
85 + "Mensagens": null
86 +}
101 101  {{/code}}
102 102  
103 103  == Campos ==
104 104  
105 -= =
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 +
106 106  )))
107 107  
108 108  
WBS Tecnologia (C) 2024
1.2