Exclusão de registro
Este tópico lista as características do WebService Json de exclusão de registros no banco de dados.
Este método deverá ser chamado para realizar a exclusão registros em determinada tabela do MentorWeb.
Nome do método: excluiDados
1. Parâmetros para chamada do WebService
Parâmetro | Descrição | Obrigatório | Tipo | Observação |
---|---|---|---|---|
tabela | Tabela que terá registros excluídos | Sim | Object | Informar a tabela que terá registros excluídos. |
filtrosComValores | Filtros e respectivos valores que irão restringir a exclusão. | Não | String | Informar os campos de filtro com seus respectivos valores, separando cada campo por vírgula. Exemplo: PES_ID = 10 |
token | Deve-se passar no cabeçalho da requisição o parâmetro token. O valor deste parâmetro é gerado pelo serviço Geração do token de segurança. |
2. Exemplo de chamada do WebService
URL: http://IP:PORTA/APLICACAO/rest/ICorujaCOM/excluiDados
2.1. Exemplo da passagem de parâmetros por Json:
{ "tabela":"TB_CONCEITO", "filtrosComValores":"CTO_ID = 22" }
2.2. Exemplo de chamada do WebService na linguagem PHP
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_PORT => "8080", CURLOPT_URL => "http://192.168.0.66:8080/ICoruja/rest/ICorujaCOM/excluiDados", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => '{ "filtrosComValores":"CTO_ID = 21", "tabela":"TB_CONCEITO"}', CURLOPT_HTTPHEADER => array( "cache-control: no-cache", "content-type: application/json", "postman-token: 74e6008c-0675-fb7c-87d0-23adcbeddd9a", "token: 9744180c4184a6c2ae283860ab1513480ed2ea8d" ) )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ?>
2.3. Exemplo de chamada do WebService no PostMan
3. Retorno do WebService Json
Esse WebService não possui retorno (204 - No content).
Sempre que o status http for 204, significa que o processo foi realizado com sucesso.
Caso o código de status http não for 204, ocorreu alguma falha. Quando ocorre alguma falha tratada, o WebService irá retornar conforme exemplo abaixo, onde o código do erro deverá ser consultado no tópico 3.1. Possíveis retornos para o chamador do WebService:
{ "codigoErroClass": "br.com.edusoftbase.icorujaclient.tipo.TipoErroComum", "codigoErro": "ICM_00404", "central": false }
3.1. Possíveis retornos para o chamador do WebService
Código | Descrição | Observação |
---|---|---|
ICM_00400 | Parâmetros inválidos | Ocorre quando não foram informados os parâmetros campos, valores ou tabela. |
ICM_00404 | Token inválido | Ocorre quando o token não foi passado ou é inválido. Lembre-se de que o token tem um período de validade definido. Gere o token novamente, e chame novamente este WebService. |
ICM_00409 | Ocorreu um erro ao realizar a operação. | Ocorre quando acontece um erro na instrução sql montada. Um exemplo, seria informar um campo que não existe na tabela informada. Verifique no retorno o atributo mensagemErro para maiores detalhes. |
ICM_00411 | Erro de conexão com banco de dados | Ocorre quando não foi possível obter a conexão com o banco de dados do MentorWeb. |