Changes for page Nota Fiscal - Obter XML ou Danfe
Last modified by WBS Tecnologia on 2021/10/04 12:05
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,20 +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: Tokendeutenticação23 +* 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 = Semresultados30 +* 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,35 +34,85 @@ 34 34 35 35 = Detalhes da Ação = 36 36 37 - RealizaaListagemResumidadosprodutos quesofreram mudança deestoquenoCatálogoapartir daultimas X horas indicadas.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 - "CodigoDeBarras": "9788577531912", 54 - "Estoque": 1, 55 - "Preco": 59.90, 56 - "Situacao": 0, 57 - "Id": 143758, 58 - "Versao": null 59 - }, 60 -... 82 +{ 83 + "Codigo": 200, 84 + "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4", 85 + "Mensagens": null 86 +} 61 61 {{/code}} 62 62 63 -== Observações ==89 +== Campos == 64 64 65 -= = 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 + 66 66 ))) 67 67 68 68 ... ... @@ -80,3 +80,5 @@ 80 80 {{/box}} 81 81 ))) 82 82 ))) 133 + 134 +