Last modified by WBS Tecnologia on 2021/10/04 12:05
From version < 2.1 >
edited by WBS Tecnologia
on 2020/12/28 20:21
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
Content
... ... @@ -14,20 +14,20 @@
14 14  
15 15  (% class="box infomessage" %)
16 16  (((
17 -Rota: /BDIApi/Produto/Listar
17 +Rota: /Modulo/Controller/Acao/{id}
18 18  )))
19 19  
20 -* Parâmetros: Nenhum
20 +* Parâmetros: 
21 +** Id = //Opcional //
21 21  * Requer Autenticação: **Sim **
22 -* Método: **GET**
23 -* Tipo de Retorno**: List<Produto> | Void | Produto**
24 -* Headers:
25 -** API_TOKEN: Token de Autenticação
26 -** 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
27 27  
28 28  == Códigos de Status ==
29 29  
30 -* 404 = Sem resultados
30 +* 404 = Não Existe o TObjeto
31 31  * 500 = Erro Interno do Servidor
32 32  * 200 = OK
33 33  * 403 = Acesso Negado, Token de Autenticação Inválido?
... ... @@ -34,74 +34,85 @@
34 34  
35 35  = Detalhes da Ação =
36 36  
37 -Realiza a Listagem de Todos os Produtos no Catálogo.
37 +Ação serve para realizar o procedimento "X" na plataforma...
38 38  
39 -=== (% style="font-size:26px" %)Headers(%%) ===
39 +== Payload ==
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 +
41 41  Abaixo segue os headers que devem ou podem ser passados para a ação:
42 42  
43 43  |=Header|=Descrição / Validação|=Valor Padrão
44 -|API_TOKEN|[Obrigatório] Token da Autenticação|
64 +|API_TOKEBN|[Obrigatório] Token da Autenticação|
65 +| | |
66 +| | |
45 45  
46 -== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
68 +== Query String ==
47 47  
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 +
48 48  Este é o Payload do resultado caso a ação tenha sucesso:
49 49  
50 50  {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
51 -[
52 - {
53 - "Estoque": 0,
54 - "Preco": 16.50,
55 - "Situacao": 0,
56 - "Edicao": "",
57 - "EstoqueMinimo": 0,
58 - "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.",
59 - "Visivel": true,
60 - "NumeroDePaginas": 48,
61 - "Peso": 0.276000,
62 - "Formato": "23x30 ",
63 - "Lombada": "0.3 ",
64 - "Acabamento": " ",
65 - "Categorias": [
66 - "HQs e Mangás",
67 - "",
68 - ""
69 - ],
70 - "UrlDaCapa": "",
71 - "Autores": [
72 - {
73 - "Nome": "DIVERSOS ",
74 - "Biografia": "",
75 - "UrlDaFoto": "",
76 - "Id": 31671,
77 - "Versao": null
78 - }
79 - ],
80 - "Editora": "DEVIR ",
81 - "ValorEBook": 0.00,
82 - "PedacoDoLivro": "",
83 - "PalavrasChave": "",
84 - "Traducao": "",
85 - "Descricao": "Flagelo dos Deuses, O",
86 - "Subtitulo": null,
87 - "LancadoEm": "0001-01-01T00:00:00",
88 - "PublicadoEm": null,
89 - "AtualizadoEm": null,
90 - "CodigoDeBarras": "9728631626",
91 - "StatusId": 0,
92 - "EmpresaId": null,
93 - "GrupoId": null,
94 - "TipoId": null,
95 - "CriadoEm": "2019-09-10T09:38:10.053",
96 - "Id": 185244,
97 - "Versao": null
98 - },
99 -...
82 +{
83 + "Codigo": 200,
84 + "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
85 + "Mensagens": null
86 +}
100 100  {{/code}}
101 101  
102 102  == Campos ==
103 103  
104 -= =
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 +
105 105  )))
106 106  
107 107  
WBS Tecnologia (C) 2024
1.2