English
Español
Web service Com.senior.g5.co.cad.ramoatividade
O serviço tem por finalidade tratar a exportação dos ramos de atividades inerentes a cada cliente desde que estejam devidamente cadastrados no sistema. Estas informações são utilizadas basicamente para consultas de vendas, faturamento, títulos em aberto classificados por ramo de atividade.
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_ramoatividade?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_ramoatividade?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_ramoatividade?wsdl
Porta
Exportar
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
Parâmetros da 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>
<codRam>String</codRam>
<FiltroRamoAtividades>
<codRam>String</codRam>
</FiltroRamoAtividades>
<codFil>Integer</codFil>
<identificadorSistema>String</identificadorSistema>
<quantidadeRegistros>Integer</quantidadeRegistros>
<tipoIntegracao>String</tipoIntegracao>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Preenchimento | Descrição |
|---|---|---|---|
| codEmp | Integer | Obrigatório | (Obrigatório) - Number (004) - Código da Empresa |
| codRam | String | Opcional | (Opcional) String (10) - Código do ramo de atividades |
| filtroRamoAtividades | Set | Opcional | Grupo de ramos de atividades (consulta em lote) |
| filtroRamoAtividades.codRam | String | Opcional | Códigos dos ramos de atividade |
| codFil | Integer | Obrigatório | (Obrigatório) - Number (005) - Código da Filial |
| identificadorSistema | String | Obrigatório | (Obrigatório) - String (15) - Sigla do Sistema de Integração |
| quantidadeRegistros | Integer | Opcional | (Opcional) - Number (005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado |
| tipoIntegracao | String | Obrigatório | (Obrigatório) - String (001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
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>
<Erros>
<mensagemErro>String</mensagemErro>
</Erros>
<tipoRetorno>Integer</tipoRetorno>
<RamoAtividades>
<seqInt>Integer</seqInt>
<codRam>String</codRam>
<desRam>String</desRam>
<abrRam>String</abrRam>
<camposUsuario>
<campo>String</campo>
<valor>String</valor>
</camposUsuario>
</RamoAtividades>
<mensagemRetorno>String</mensagemRetorno>
<finalizaramRegistros>String</finalizaramRegistros>
<numeroLote>Integer</numeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:| Nome | Tipo | Preenchimento | Descrição |
|---|---|---|---|
| erros | Set | Opcional | (Opcional) - Lista dos erro |
| erros.mensagemErro | String | Opcional | (Opcional) - Itens da lista de erros |
| tipoRetorno | Integer | Opcional | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| ramoAtividades | Set | Opcional | Lista de ramo de atividades |
| ramoAtividades.seqInt | Integer | Opcional | Código sequencial da tabela de pendências de integração |
| ramoAtividades.codRam | String | Opcional | String (005) - Código do ramo de atividade |
| ramoAtividades.desRam | String | Opcional | String (100) - Descrição do ramo de atividade |
| ramoAtividades.abrRam | String | Opcional | String (010) - Abreviatura do ramo de atividade |
| camposUsuario | Set | Opcional | Lista de campos de usuário |
| camposUsuario.campo | String | Opcional | Nome do campo |
| camposUsuario.valor | String | Opcional | Valor do campo |
| mensagemRetorno | String | Opcional | (Obrigatório) - String (1000) - Mensagem de Retorno de Processamento |
| finalizaramRegistros | String | Opcional | (Obrigatório) - String (001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| numeroLote | Integer | Opcional | Obrigatório - Inteiro - Identificação do Lote de Exportação |
| erroExecucao | String | Opcional | 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
