Inclusão de registro

Este tópico lista as características do WebService Json de inclusão de registros no banco de dados.
Este método deverá ser chamado para realizar a inclusão de registro em determinada tabela do MentorWeb.

Nome do método: insereDados

1. Parâmetros para chamada do WebService

Parâmetro Descrição Obrigatório Tipo Observação
campos Campos que serão inseridos Sim String Informar os campos que serão inseridos
valores Valores que serão inseridos Sim Object Informar os valores que serão inseridos, na mesma ordem em que estão os campos. Exemplo:
campos: PES_NOME, PES_FONE, PES_EMAIL
valores: João, 47999999999, [email protected]
tabela Tabela onde será inserido o registro Sim String Informar a tabela onde o registro será inserido
sequenceOracle Sequence da tabela, deve-se informar a sequence do campo, exemplo: PES_ID.nextval Não String Parâmetro obrigatório somente no oracle
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/insereDados


2.1. Exemplo da passagem de parâmetros por Json:

{
    "campos":"CTO_DESCRI, ATIVO, UNIDON,GRUPO_UNIDON, DATA_ULT_ALTERACAO, USUARIO_ULT_ALTERACAO, VERSAO, CTO_CODINTEG",
    "valores":"'Conceito de teste', 1, 1,1, GETDATE(), 1,1, 1",
    "tabela":"TB_CONCEITO"
}
2.2. Exemplo de chamada do WebService na linguagem PHP

<?php
header('Content-Type: text/html; charset=utf-8');
$curl = curl_init();
 
curl_setopt_array($curl, array(
    CURLOPT_PORT => "8080",
    CURLOPT_URL => "http://192.168.0.66:8080/ICoruja/rest/ICorujaCOM/insereDados",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{"campos":"CTO_DESCRI, ATIVO, UNIDON,GRUPO_UNIDON, DATA_ULT_ALTERACAO, USUARIO_ULT_ALTERACAO, VERSAO, CTO_CODINTEG",
	"valores":"\'Conceito de teste\', 1, 1,1, GETDATE(), 1,1, 1", "tabela":"TB_CONCEITO"}',
    CURLOPT_HTTPHEADER => array(
        "cache-control: no-cache",
        "content-type: application/json",
        "postman-token: 74e6008c-0675-fb7c-87d0-23adcbeddd9a",
		"token: 2c8fe5b024ed0f22901c01214e5224cb113be05b"
    )
));
 
$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

Passando o token

Passando os demais parâmetros

3. Retorno do WebService Json



Para obter o retorno do WebService deve-se verificar o status da requisição http. Sempre que o status for 200, significa que o processo foi realizado com sucesso, e o valor foi inserido corretamente.

3.1. Atributos retornados do WebService para o chamador

Campo Descrição Tipo Observação
chave Retorna a descrição “identificador” String(13) Valor fixo, “identificador”.
valor Retorna identificador (PK) que foi inserido Inteiro Retorna o valor do identificador PK da tabela.
Anteção: Esse valor só é retornado quando a PK é auto incremento. Caso contrário, não irá retornar esse atributo.


Para obter o retorno do WebService deve-se verificar o status da requisição http.

Sempre que o status for 200, significa que o processo foi realizado com sucesso, e o token foi gerado corretamente. Neste caso, o retorno é apresentado conforme o exemplo abaixo: 

{
    "chave": "identificador",
    "valor": 34
}

Caso o código de status não for 200, 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. Possíveis retornos para o chamador do WebService: 

{
    "codigoErroClass": "br.com.edusoftbase.icorujaclient.tipo.TipoErroComum",
    "codigoErro": "ICM_00404",
    "central": false
}
3.2. 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.


  • (edição externa)