PUT api/cadastro/{idcadastro}/Encerrar
Encerra o cadastro indicado
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
idcadastro |
Código do cadastro do cliente |
integer |
Required |
Body Parameters
Dados do encerramento
CadastroEncerramentoDadosName | Description | Type | Additional information |
---|---|---|---|
motivo_id |
Código do motivo do encerramento (idporque). Veja: api/cadastro/getMotivosCancelamento |
integer |
None. |
motivo_nome |
Motivo do encerramento conforme id informado |
string |
None. |
submotivo_id |
Submotivo do encerramento do cadastro (idsubmotivo) |
integer |
None. |
observacoes |
Observações extras do encerramento |
string |
None. |
dispensar_multarescisoria |
Informe 1 para não cobrar a multa rescisória, 0 para cobrar a multa, caso haja. |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "motivo_id": 1, "motivo_nome": "sample string 2", "submotivo_id": 3, "observacoes": "sample string 4", "dispensar_multarescisoria": 5 }
application/xml, text/xml
Sample:
<CadastroEncerramentoDados xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp"> <dispensar_multarescisoria>5</dispensar_multarescisoria> <motivo_id>1</motivo_id> <motivo_nome>sample string 2</motivo_nome> <observacoes>sample string 4</observacoes> <submotivo_id>3</submotivo_id> </CadastroEncerramentoDados>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RespostaServidorName | Description | Type | Additional information |
---|---|---|---|
resposta |
Código da resposta: 1=Positivo, 0=Negativo |
integer |
None. |
msg |
Mensagem de retorno de acordo com o comando executado |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "resposta": 1, "msg": "sample string 2" }
application/xml, text/xml
Sample:
<RespostaServidor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp"> <msg>sample string 2</msg> <resposta>1</resposta> </RespostaServidor>