Changes for page Pedidos - Formas de Pagamento

Summary

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

Details

Page properties

Title

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

Content

...	...	@@ -2,9 +2,7 @@
2	2	(((
3	3	(% class="container" %)
4	4	(((
5		-= Listar Todos os Tipos de Envio =
6		-
7		-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
	5	+= Listar Todos os Produtos =
8	8	)))
9	9	)))
10	10
...	...	@@ -16,20 +16,20 @@
16	16
17	17	(% class="box infomessage" %)
18	18	(((
19		-Rota: /BDIApi/TipoEnvio/Listar
	17	+Rota: /Modulo/Controller/Acao/{id}
20	20	)))
21	21
22		-* Parâmetros: Nenhum
	20	+* Parâmetros:
	21	+** Id = //Opcional //
23	23	* Requer Autenticação: **Sim **
24		-* Método: **GET**
25		-* Tipo de Retorno**: List<TipoEnvio> | Void | TipoEnvio**
26		-* Headers:
27		-** API_TOKEN: Token de Autenticação
28		-** 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
29	29
30	30	== Códigos de Status ==
31	31
32		-* 404 = Sem resultados
	30	+* 404 = Não Existe o TObjeto
33	33	* 500 = Erro Interno do Servidor
34	34	* 200 = OK
35	35	* 403 = Acesso Negado, Token de Autenticação Inválido?
...	...	@@ -36,45 +36,85 @@
36	36
37	37	= Detalhes da Ação =
38	38
39		-Realiza a Listagem de Todos os Produtos no Catálogo.
	37	+Ação serve para realizar o procedimento "X" na plataforma...
40	40
41		-=== (% style="font-size:26px" %)Headers(%%) ===
	39	+== Payload ==
42	42
	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	+
43	43	Abaixo segue os headers que devem ou podem ser passados para a ação:
44	44
45	45	|=Header|=Descrição / Validação|=Valor Padrão
46		-|API_TOKEN|[Obrigatório] Token da Autenticação|
	64	+|API_TOKEBN|[Obrigatório] Token da Autenticação|
	65	+| | |
	66	+| | |
47	47
48		-== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
	68	+== Query String ==
49	49
	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	+
50	50	Este é o Payload do resultado caso a ação tenha sucesso:
51	51
52	52	{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
53		-[
54		- {
55		- "Id": 1,
56		- "Codigo": 1,
57		- "Descricao": "SEDEX",
58		- "CodigoInterno": 15159,
59		- "AtualizadoEm": null,
60		- "Versao": null
61		- },
62		- {
63		- "Id": 2,
64		- "Codigo": 2,
65		- "Descricao": "PAC",
66		- "CodigoInterno": 18484,
67		- "AtualizadoEm": null,
68		- "Versao": null
69		- },
70		-....
	82	+{
	83	+ "Codigo": 200,
	84	+ "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
	85	+ "Mensagens": null
	86	+}
71	71	{{/code}}
72	72
73		-== Observações ==
	89	+== Campos ==
74	74
75		-Esta ROTA implementa a Batch API, chamadas devem respeitar os parâmetros de paginação.
	91	+|=Campo|=Descrição
	92	+|Codigo|200 = Sucesso na Autenticação
	93	+|Token|Token de Acesso a API
	94	+|Mensagens|Mensagens de Erro
76	76
77		-= =
	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	+
78	78	)))
79	79
80	80