Webservice (Comercial Contratos - Confirmar aceite do contrato): mudanças entre as edições
Ir para navegação
Ir para pesquisar
(Criou página com ' Voltar ao menu Webservice Comercial Contratos') |
Sem resumo de edição |
||
Linha 1: | Linha 1: | ||
'''Descrição:''' Faz a confirmação do Aceite. | |||
'''URL:''' https://[URL]/ws/comercial/contratos/aceite/{idContrato} | |||
'''Método:''' GET | |||
'''Entrada:''' Pelo Path Param passar o código do contrato, e pelo Header o Token gerado no método Gera Token. | |||
'''Saída:''' PDF com o modelo de aceite de contrato. | |||
'''Campos JSON de entrada:''' | |||
{| class="wikitable" | |||
|'''Tag''' | |||
|'''Tipo Parâmetro''' | |||
|'''Tipo''' | |||
|'''Obrigatório''' | |||
|'''Observação''' | |||
|- | |||
|idContrato | |||
|Path Param | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|Token | |||
|Header | |||
|String | |||
|SIM | |||
| | |||
|} | |||
'''Exemplo:''' | |||
* '''Envio:''' | |||
** https://[URL]/ws/comercial/contratos/aceite/{idContrato} | |||
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"usuario":"12312312312", | |||
"senha":"12312312312" | |||
} | |||
</syntaxhighlight> | |||
* '''Retorno:''' | |||
** '''Sucesso:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"Status":"OK", | |||
"Mensagem":"Aceite realizado com sucesso." | |||
} | |||
</syntaxhighlight> | |||
** '''Erro:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"Status":"INTERNAL_SERVER_ERROR", | |||
"Mensagem":"Não foi possível realizar o aceite." | |||
} | |||
</syntaxhighlight> | |||
[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] | [[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] |
Edição atual tal como às 18h21min de 19 de maio de 2023
Descrição: Faz a confirmação do Aceite.
URL: https://[URL]/ws/comercial/contratos/aceite/{idContrato}
Método: GET
Entrada: Pelo Path Param passar o código do contrato, e pelo Header o Token gerado no método Gera Token.
Saída: PDF com o modelo de aceite de contrato.
Campos JSON de entrada:
Tag | Tipo Parâmetro | Tipo | Obrigatório | Observação |
idContrato | Path Param | String | SIM | |
Token | Header | String | SIM |
Exemplo:
- Envio:
- https://[URL]/ws/comercial/contratos/aceite/{idContrato}
- Parâmetros adicionais:
{ "usuario":"12312312312", "senha":"12312312312" }
- Parâmetros adicionais:
- https://[URL]/ws/comercial/contratos/aceite/{idContrato}
- Retorno:
- Sucesso:
{ "Status":"OK", "Mensagem":"Aceite realizado com sucesso." }
- Erro:
{ "Status":"INTERNAL_SERVER_ERROR", "Mensagem":"Não foi possível realizar o aceite." }
- Sucesso: