Wiki source code of Produtos - Todos
Version 1.1 by WBS Tecnologia on 2020/12/28 20:06
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="jumbotron" %) | ||
| 2 | ((( | ||
| 3 | (% class="container" %) | ||
| 4 | ((( | ||
| 5 | = Listar Todos os Produtos = | ||
| 6 | ))) | ||
| 7 | ))) | ||
| 8 | |||
| 9 | (% class="row" %) | ||
| 10 | ((( | ||
| 11 | (% class="col-xs-12 col-sm-8" %) | ||
| 12 | ((( | ||
| 13 | = Detalhes da Rota = | ||
| 14 | |||
| 15 | (% class="box infomessage" %) | ||
| 16 | ((( | ||
| 17 | Rota: /Modulo/Controller/Acao/{id} | ||
| 18 | ))) | ||
| 19 | |||
| 20 | * Parâmetros: | ||
| 21 | ** Id = //Opcional // | ||
| 22 | * Requer Autenticação: **Sim ** | ||
| 23 | * Método: **POST** | ||
| 24 | * Tipo de Retorno**: List<TObjeto> | Void | TObjeto** | ||
| 25 | * Permissão**: ** | ||
| 26 | ** WinBooks.Agentes.Agente.Visualizar | ||
| 27 | |||
| 28 | == Códigos de Status == | ||
| 29 | |||
| 30 | * 404 = Não Existe o TObjeto | ||
| 31 | * 500 = Erro Interno do Servidor | ||
| 32 | * 200 = OK | ||
| 33 | * 403 = Acesso Negado, Token de Autenticação Inválido? | ||
| 34 | |||
| 35 | = Detalhes da Ação = | ||
| 36 | |||
| 37 | Ação serve para realizar o procedimento "X" na plataforma... | ||
| 38 | |||
| 39 | == Payload == | ||
| 40 | |||
| 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 | |||
| 61 | Abaixo segue os headers que devem ou podem ser passados para a ação: | ||
| 62 | |||
| 63 | |=Header|=Descrição / Validação|=Valor Padrão | ||
| 64 | |API_TOKEBN|[Obrigatório] Token da Autenticação| | ||
| 65 | | | | | ||
| 66 | | | | | ||
| 67 | |||
| 68 | == Query String == | ||
| 69 | |||
| 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 | |||
| 79 | Este é o Payload do resultado caso a ação tenha sucesso: | ||
| 80 | |||
| 81 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
| 82 | { | ||
| 83 | "Codigo": 200, | ||
| 84 | "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4", | ||
| 85 | "Mensagens": null | ||
| 86 | } | ||
| 87 | {{/code}} | ||
| 88 | |||
| 89 | == Campos == | ||
| 90 | |||
| 91 | |=Campo|=Descrição | ||
| 92 | |Codigo|200 = Sucesso na Autenticação | ||
| 93 | |Token|Token de Acesso a API | ||
| 94 | |Mensagens|Mensagens de Erro | ||
| 95 | |||
| 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 | |||
| 116 | ))) | ||
| 117 | |||
| 118 | |||
| 119 | (% class="col-xs-12 col-sm-4" %) | ||
| 120 | ((( | ||
| 121 | {{box title="**Índice**"}} | ||
| 122 | {{toc/}} | ||
| 123 | {{/box}} | ||
| 124 | |||
| 125 | {{box}} | ||
| 126 | **Exemplos** | ||
| 127 | |||
| 128 | * Exemplo de Payload: BAIXAR | ||
| 129 | * Exemplo de Resultado: BAIXAR | ||
| 130 | {{/box}} | ||
| 131 | ))) | ||
| 132 | ))) | ||
| 133 | |||
| 134 |