Exibir código-fonte para Webservice (Comercial Contratos - Habilitar contrato em confiança)


'''Descrição:''' Habilita o plano em confiança

'''URL:''' https://[URL]/ws/comercial/contrato/{idContrato}/webservice/alterar/status?descricaoStatus={descricaoStatus}&acesso Central={s}

'''Método:''' POST

'''Entrada:''' Por Path Param passar o código do contrato, por Query Param passar a descrição do status e o acesso central e JSON contendo usuário e senha.

'''Saída:''' JSON contendo um Map com o retorno do resultado de execução do método.

'''Campos JSON de entrada:'''
{| class="wikitable"
|'''Tag'''
|'''Tipo Parâmetro'''
|'''Tipo'''
|'''Obrigatório'''
|'''Observação'''
|-
|usuario
|body
|String
|SIM
|
|-
|senha
|body
|String
|SIM
|
|-
|idContrato
|Path Param
|String
|SIM
|
|-
|descricaoStatus
|Query Param
|String
|SIM
|
|}
'''Exemplo:'''

* '''Envio:'''
** https://[URL]/ws/comercial/contrato/{idContrato}/webservice/alterar/status?descricaoStatus={descricaoStatus}&acesso Central={s}
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
{
   "usuario":"12312312312",
   "senha":"12312312312"
}
</syntaxhighlight>
* '''Retorno:'''
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
{
   "success":"Contrato Alterado, DataHabilitacaoConfiancaFim"
}
</syntaxhighlight>
** '''Erro:'''
*** Em caso de erro na alteração do status:<syntaxhighlight lang="json" line="1">
{
   "error":"Erro ao habilitar o contrato"
}
</syntaxhighlight>
*** Se o contrato já tiver sido habilitado em confiança recentemente: <syntaxhighlight lang="json" line="1">
{
   "error":" Não é possível habilitar o contrato pois já foi realizada uma habilitação em confiança nos últimos {parâmetro com o valor máximo de dias cadastrados em banco} dias"
}
</syntaxhighlight>

[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]]