Web service com.senior.g5.rh.fp.genericpersistente.Generic.Persistence

Web service utilizado para integração entre o HCM | XTended e o HCM | senior X em casos onde o usuário deseje inserir/excluir/alterar uma informação do HCM | senior X para o ambiente HCM | XTended.

Tipo de execução

Para cada tipo de execução, existem parâmetros específicos, alguns dos quais podem ser comuns a todas as portas de web service.

Autenticação

Quando for utilizada alguma forma de autenticação na integração de informações por meio de web services, é necessário informar o tipo correspondente no parâmetro <encryption>, conforme os valores possíveis.

WSDL

Porta

GenericPersistence

Necessita autenticação: Sim

Situação da versão: Atual

Versão: 2

Versão atual: 2

Requisição:

<soapenv:Envelope xmlns:ser=“http://services.senior.com.br” xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/”> <soapenv:Body> <ser:GenericPersistence> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <registro> <ordem>Integer</ordem> <tabela>String</tabela> <operacaoTabela>String</operacaoTabela> <campo> <nome>String</nome> <valor>String</valor> <chave>String</chave> <valorGerado>String</valorGerado> <chavePai>String</chavePai> </campo> <regraProcesso>String</regraProcesso> <apagarPendencia>String</apagarPendencia> </registro> <operacao>String</operacao> </parameters> </ser:GenericPersistence> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

registro

Opcional

Set

Referente à tabela a qual será utilizada para fazer a integração das informações.

registro.ordem

Opcional

Integer

Ordem na qual as operações serão executadas.

registro.tabela

Opcional

String

Tabela na qual será executada a operação.

registro.operacaoTabela

Opcional

String

Operação a ser executada, sendo:



  • “I - Inserir”;

  • “A - Alterar”;

  • “E - Excluir”.

campo

Opcional

Set

Campos da tabela que serão modificados.

campo.nome

Opcional

String

Nome do campo.

campo.valor

Opcional

String

Valor do campo.

campo.chave

Opcional

String

Chave que será utilizada em um campo gerado.

campo.valorGerado

Opcional

String

Identifica se o valor será gerado automaticamente.

campo.chavePai

Opcional

String

O valor do campo será de origem a uma chave gerada.

registro.regraProcesso

Opcional

String

Código de uma regra por processo para ser executada.

registro.apagarPendencia

Opcional

String

Informa se deve apagar as pendências de integração, sendo:


  • “S”: apagará as pendências;

  • “N”: não apagará as pendências.

operacao

Opcional

String

Operação a ser executada, sendo:



  • “I - Inserir”;

  • “A - Alterar”;

  • “E - Excluir”.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:ser=“http://services.senior.com.br” xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/”> <soapenv:Body> <ser:GenericPersistenceResponse> <result> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> <erroExecucao>String</erroExecucao> </result> </ser:GenericPersistenceResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Opcional

Set

Exibe o retorno da execução do serviço.

status.codigo

Opcional

String

Código do resultado, sucesso ou erro.

status.mensagem

Opcional

String

Traz a mensagem referente ao retorno do serviço. Caso ocorra algum erro, será exibida a mensagem.

erroExecucao

Opcional

String

Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:


  • Vazio ou nulo, indicando que a execução foi feita com sucesso;

  • A mensagem do erro ocorrido no servidor.

Este artigo ajudou você?