English
Español
Web service Com.senior.g5.co.cad.cidades
Este web service permite exportar o cadastro de cidades da tabela Cidades para RAIS - SIG (E008RAI).
Para seu correto funcionamento, é necessário possuir um sistema integrado cadastrado e ativo na tela Cadastro de Sistemas Integrados (F000SIS), e ativar o tipo de informação Cidade na tela Configuração de Tipos de Informação (F000SXT) para o sistema integrado.
O web service também possui o modo consulta, e para este é necessário informar o parâmetro Cidade. Este campo permite informar somente o Código RAI da cidade, a pesquisa não é realizada pelo nome.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
Exemplo:
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
Exemplo:
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_cad_cidades?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_cidades?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_cidades?wsdl
Porta
Exportar
Exportar o cadastro de cidades da tabela E008RAI.
Necessita autenticação: Sim.
Situação da versão:Atual.
Versão: 1.
Requisição:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Exportar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <consulta> <cidade>String</cidade> </consulta> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <identificacaoSistema>String</identificacaoSistema> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| codEmp | Obrigatório | Integer | Código da Empresa. |
| consulta | |||
| consulta.cidade | Opcional | String | Consulta a Cidade. |
| codFil | Obrigatório | Integer | Código da Filial. |
| tipoIntegracao | Obrigatório | String | Tipo de Integração - Lista: T= Todos, A= Somente Alterados, E= Registro Específico. |
| quantidadeRegistros | Opcional | Integer | Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
| identificacaoSistema | Obrigatório | String | Identificação do sistema integrado. |
Resposta:Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarResponse> <result> <cidade> <codRai>Integer</codRai> <nomCid>String</nomCid> <sigUfs>String</sigUfs> <locGeo>String</locGeo> <numFeb>String</numFeb> <seqInt>Integer</seqInt> </cidade> <gridErros> <msgErr>String</msgErr> </gridErros> <finalizaramRegistros>String</finalizaramRegistros> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| cidade | |||
| cidade.codRai | Opcional | Integer | Retorno do código RAI da cidade. |
| cidade.nomCid | Opcional | String | Nome da cidade. |
| cidade.sigUfs | Opcional | String | Sigla do Estado. |
| cidade.locGeo | Opcional | String | Código localização geográfica. |
| cidade.numFeb | Opcional | String | Código do município para o Febraban. |
| cidade.seqInt | Opcional | Integer | Código sequencial do registro. |
| gridErros | Opcional | Set | Lista dos erros. |
| gridErros.msgErr | Opcional | String | Erros. |
| finalizaramRegistros | Opcional | String | Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não. |
| tipoRetorno | Opcional | Integer | Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação. |
| mensagemRetorno | Opcional | String | Mensagem de Retorno de Processamento. |
| numeroLote | Obrigatório | Integer | Identificação do Lote de Exportação. |
| 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. |
English
Español
