Wiki source code of Pedidos - Formas de Pagamento

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

author	version	line-number	content
		1	(% class="jumbotron" %)
		2	(((
		3	(% class="container" %)
		4	(((
		5	= Listar Todas as Formas de Pagamento =
		6
		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.
		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	(((
		19	Rota: /BDIApi/FormaPgto/Todos
		20	)))
		21
		22	* Parâmetros: Nenhum
		23	* Requer Autenticação: Sim
		24	* Método: GET
		25	* Tipo de Retorno: List<FormaPgto> \| Void \| FormaPgto
		26	* Headers:
		27	** API_TOKEN: Token de Autenticação
		28	** Parametros de [[Paginação>>doc:Web Rest API.Paginação.WebHome]]
		29
		30	== Códigos de Status ==
		31
		32	* 404 = Sem resultados
		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
		39	Realiza a Listagem de Todos os Produtos no Catálogo.
		40
		41	=== (% style="font-size:26px" %)Headers(%%) ===
		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
		46	\|API_TOKEN\|[Obrigatório] Token da Autenticação\|
		47
		48	== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
		49
		50	Este é o Payload do resultado caso a ação tenha sucesso:
		51
		52	{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
		53	[
		54	{
		55	"Id": 1,
		56	"Codigo": 1,
		57	"Descricao": "Boleto bancário",
		58	"CodigoInterno": 3,
		59	"AtualizadoEm": null,
		60	"Tipo": null,
		61	"AltCodigo": null,
		62	"Versao": null
		63	},
		64	{
		65	"Id": 2,
		66	"Codigo": 2,
		67	"Descricao": "Cartão Crédito SITEF SITE",
		68	"CodigoInterno": 49,
		69	"AtualizadoEm": null,
		70	"Tipo": null,
		71	"AltCodigo": null,
		72	"Versao": null
		73	},
		74	.....
		75	{{/code}}
		76
		77	== Observações ==
		78
		79	Esta ROTA implementa a Batch API, chamadas devem respeitar os parâmetros de paginação.
		80
		81	= =
		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	)))