Changes for page Pedidos - Formas de Pagamento

Last modified by WBS Tecnologia on 2021/01/14 16:47

From version 1.1 >

edited by WBS Tecnologia
on 2020/12/28 20:06

To version < 4.1 >

edited by WBS Tecnologia
on 2021/01/14 16:44

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Produtos - Todos
++Pedidos - Tipos de Envio

Content

@@ -2,7 +2,9 @@
  (((
  (% class="container" %)
  (((
--= Listar Todos os Produtos =
++= Listar Todos os Tipos de Envio =
++
++Para inserir um pedido é necessário informar o ID do tipo de envio correto, que são pré-configurados de acordo com a Catavento./BDIApi/TipoEnvio/Todos
  )))
  )))
@@ -14,20 +14,20 @@
  (% class="box infomessage" %)
  (((
--Rota: /Modulo/Controller/Acao/{id}
++Rota: /BDIApi/TipoEnvio/Listar
  )))
--* Parâmetros:
--** Id = //Opcional //
++* Parâmetros: Nenhum
  * Requer Autenticação: **Sim **
--* Método: **POST**
--* Tipo de Retorno**: List<TObjeto> | Void | TObjeto**
--* Permissão**: **
--** WinBooks.Agentes.Agente.Visualizar
++* Método: **GET**
++* Tipo de Retorno**: List<TipoEnvio> | Void | TipoEnvio**
++* Headers:
++** API_TOKEN: Token de Autenticação
++** Parametros de [[Paginação>>doc:Web Rest API.Paginação.WebHome]]
  == Códigos de Status ==
--* 404 = Não Existe o TObjeto
++* 404 = Sem resultados
  * 500 = Erro Interno do Servidor
  * 200 = OK
  * 403 = Acesso Negado, Token de Autenticação Inválido?
@@ -34,85 +34,45 @@
  = Detalhes da Ação =
--Ação serve para realizar o procedimento "X" na plataforma...
++Realiza a Listagem de Todos os Produtos no Catálogo.
--== Payload ==
++=== (% style="font-size:26px" %)Headers(%%) ===
--Se a ação receber um conteudo "Payload", aqui deve ser descrito este conteudo, com campos e validações.
--
--* Content-Type: application/json
--
--{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
--{
-- "Email": "winbooks@winbooks.com.br",
-- "Senha": "0806"
--}
--{{/code}}
--
--=== Campos e Validações ===
--
--|=Campo|=Descrição / Validação|=Valor Padrão
--|Email|[Obrigatório] Email para a Autenticação|
--|Senha|[Obrigatório] Senha para a Autenticação|
--| | |
--
--== Headers ==
--
  Abaixo segue os headers que devem ou podem ser passados para a ação:
  |=Header|=Descrição / Validação|=Valor Padrão
--|API_TOKEBN|[Obrigatório] Token da Autenticação|
--| | |
--| | |
++|API_TOKEN|[Obrigatório] Token da Autenticação|
--== Query String ==
++== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
--Abaixo segue os parâmetros que podem ser passados via QueryString:
--
--|=Header|=Descrição / Validação|=Valor Padrão
--|nome|[Obrigatório] Parâmetro para a Pesquisa pelo Nome|
--| | |
--| | |
--
--= Detalhes do Resultado =
--
  Este é o Payload do resultado caso a ação tenha sucesso:
  {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
--{
--  "Codigo": 200,
--  "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
--  "Mensagens": null
--}
++[
++  {
++    "Id": 1,
++    "Codigo": 1,
++    "Descricao": "SEDEX",
++    "CodigoInterno": 15159,
++    "AtualizadoEm": null,
++    "Versao": null
++  },
++  {
++    "Id": 2,
++    "Codigo": 2,
++    "Descricao": "PAC",
++    "CodigoInterno": 18484,
++    "AtualizadoEm": null,
++    "Versao": null
++  },
++....
  {{/code}}
--== Campos ==
++== Observações ==
--|=Campo|=Descrição
--|Codigo|200 = Sucesso na Autenticação
--|Token|Token de Acesso a API
--|Mensagens|Mensagens de Erro
++Esta ROTA implementa a Batch API, chamadas devem respeitar os parâmetros de paginação.
--= Exemplos =
--
--== Pesquisar um Atributo pelo CPF/CNPJ ==
--
--/Cadastros/Agente/AtributoPara?chave=Professor.Aprovado&documento=42473060061&id=0
--
--|=Nome|=Valor
--|chave|Professor.Aprovado
--|id|0
--|documento|42473060061
--
--== Pesquisar um Atributo pelo ID ==
--
--/Cadastros/Agente/AtributoPara?chave=Professor.Aprovado&id=120
--
--|=Nome|=Valor
--|chave|Professor.Aprovado
--|id|120
--
--
++=   =
  )))