Wiki source code of Pedidos - Formas de Pagamento

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

version	line-number	content
1.1	1	(% class="jumbotron" %)
	2	(((
	3	(% class="container" %)
	4	(((
5.1	5	= Listar Todas as Formas de Pagamento =
4.1	6
5.1	7	Para inserir um pedido é necessário informar o ID da forma de pagamento correto nas faturas, tais formas são pré-configuradas de acordo com a Catavento.
1.1	8	)))
	9	)))
	10
	11	(% class="row" %)
	12	(((
	13	(% class="col-xs-12 col-sm-8" %)
	14	(((
	15	= Detalhes da Rota =
	16
	17	(% class="box infomessage" %)
	18	(((
5.1	19	Rota: /BDIApi/FormaPgto/Todos
1.1	20	)))
	21
2.1	22	* Parâmetros: Nenhum
1.1	23	* Requer Autenticação: Sim
2.1	24	* Método: GET
5.1	25	* Tipo de Retorno: List<FormaPgto> \| Void \| FormaPgto
2.1	26	* Headers:
	27	** API_TOKEN: Token de Autenticação
	28	** Parametros de [[Paginação>>doc:Web Rest API.Paginação.WebHome]]
1.1	29
	30	== Códigos de Status ==
	31
2.1	32	* 404 = Sem resultados
1.1	33	* 500 = Erro Interno do Servidor
	34	* 200 = OK
	35	* 403 = Acesso Negado, Token de Autenticação Inválido?
	36
	37	= Detalhes da Ação =
	38
2.1	39	Realiza a Listagem de Todos os Produtos no Catálogo.
1.1	40
2.1	41	=== (% style="font-size:26px" %)Headers(%%) ===
1.1	42
	43	Abaixo segue os headers que devem ou podem ser passados para a ação:
	44
	45	\|=Header\|=Descrição / Validação\|=Valor Padrão
2.1	46	\|API_TOKEN\|[Obrigatório] Token da Autenticação\|
1.1	47
2.1	48	== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
1.1	49
	50	Este é o Payload do resultado caso a ação tenha sucesso:
	51
	52	{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
2.1	53	[
	54	{
4.1	55	"Id": 1,
	56	"Codigo": 1,
5.1	57	"Descricao": "Boleto bancário",
	58	"CodigoInterno": 3,
2.1	59	"AtualizadoEm": null,
5.1	60	"Tipo": null,
	61	"AltCodigo": null,
2.1	62	"Versao": null
	63	},
4.1	64	{
	65	"Id": 2,
	66	"Codigo": 2,
5.1	67	"Descricao": "Cartão Crédito SITEF SITE",
	68	"CodigoInterno": 49,
4.1	69	"AtualizadoEm": null,
5.1	70	"Tipo": null,
	71	"AltCodigo": null,
4.1	72	"Versao": null
	73	},
5.1	74	.....
1.1	75	{{/code}}
	76
3.1	77	== Observações ==
1.1	78
3.1	79	Esta ROTA implementa a Batch API, chamadas devem respeitar os parâmetros de paginação.
	80
2.1	81	= =
1.1	82	)))
	83
	84
	85	(% class="col-xs-12 col-sm-4" %)
	86	(((
	87	{{box title="Índice"}}
	88	{{toc/}}
	89	{{/box}}
	90
	91	{{box}}
	92	Exemplos
	93
	94	* Exemplo de Payload: BAIXAR
	95	* Exemplo de Resultado: BAIXAR
	96	{{/box}}
	97	)))
	98	)))
	99