Wiki source code of Pedidos - Tipos de Envio
Version 4.1 by WBS Tecnologia on 2021/01/14 16:44
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="jumbotron" %) | ||
| 2 | ((( | ||
| 3 | (% class="container" %) | ||
| 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 | ||
| 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/TipoEnvio/Listar | ||
| 20 | ))) | ||
| 21 | |||
| 22 | * Parâmetros: Nenhum | ||
| 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]] | ||
| 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": "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 | .... | ||
| 71 | {{/code}} | ||
| 72 | |||
| 73 | == Observações == | ||
| 74 | |||
| 75 | Esta ROTA implementa a Batch API, chamadas devem respeitar os parâmetros de paginação. | ||
| 76 | |||
| 77 | = = | ||
| 78 | ))) | ||
| 79 | |||
| 80 | |||
| 81 | (% class="col-xs-12 col-sm-4" %) | ||
| 82 | ((( | ||
| 83 | {{box title="**Índice**"}} | ||
| 84 | {{toc/}} | ||
| 85 | {{/box}} | ||
| 86 | |||
| 87 | {{box}} | ||
| 88 | **Exemplos** | ||
| 89 | |||
| 90 | * Exemplo de Payload: BAIXAR | ||
| 91 | * Exemplo de Resultado: BAIXAR | ||
| 92 | {{/box}} | ||
| 93 | ))) | ||
| 94 | ))) | ||
| 95 | |||
| 96 |