Changes for page Danfe da Nota Fiscal - Enviar
Last modified by WBS Tecnologia on 2021/06/16 14:27
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -Produtos - Estoque Desde1 +Produtos - Todos - Content
-
... ... @@ -2,7 +2,7 @@ 2 2 ((( 3 3 (% class="container" %) 4 4 ((( 5 -= Listar Produtoscom Estoque AtualizadoDesde=5 += Listar Todos os Produtos = 6 6 ))) 7 7 ))) 8 8 ... ... @@ -14,21 +14,20 @@ 14 14 15 15 (% class="box infomessage" %) 16 16 ((( 17 -Rota: / BDIApi/Produto/EstoqueDesde?horas=X17 +Rota: /Modulo/Controller/Acao/{id} 18 18 ))) 19 19 20 20 * Parâmetros: 21 -** horas=[Obrigatório] Tem que ser maiorque 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 = Semresultados30 +* 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,35 +35,85 @@ 35 35 36 36 = Detalhes da Ação = 37 37 38 - RealizaaListagemResumidadosprodutos quesofreram mudança deestoquenoCatálogoapartir daultimas 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 - "CodigoDeBarras": "9788577531912", 55 - "Estoque": 1, 56 - "Preco": 59.90, 57 - "Situacao": 0, 58 - "Id": 143758, 59 - "Versao": null 60 - }, 61 -... 82 +{ 83 + "Codigo": 200, 84 + "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4", 85 + "Mensagens": null 86 +} 62 62 {{/code}} 63 63 64 64 == Campos == 65 65 66 -= = 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 + 67 67 ))) 68 68 69 69 ... ... @@ -82,3 +82,4 @@ 82 82 ))) 83 83 ))) 84 84 134 +