English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.cad.unidadedemedida
Web service Com.senior.g5.co.cad.unidadedemedida
O serviço de Unidade de medida é usado para permitir a exportação de registros com controle de integração utilizando a porta exportar. Esse mesmo serviço também contém portas de consulta que permitem obter informações específicas da entidade principal, podendo realizar alguns filtros pré-definidos no serviço.
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_unidadedemedida?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_unidadedemedida?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_unidadedemedida?wsdl
Portas
Exportar
Após executar o web service será retornado um número de lote, esse número deve ser usado com o código da integração "2" para retornar ao ERP a confirmação de recebimento dos registros, executando o web service com.senior.g5.co.int.geral.exportacao, porta Confirmar.
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>
<UniMed>String</UniMed>
<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 | Descrição |
|---|---|---|
| CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| UniMed | String | (Opcional) - String(003) - Código da unidade de medida |
| CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| QuantidadeRegistros | Integer | (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) - 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>
<UnidadeDeMedida>
<SeqInt>Integer</SeqInt>
<UniMed>String</UniMed>
<DesMed>String</DesMed>
<QtdDec>Integer</QtdDec>
<CodReg>Integer</CodReg>
<IndExp>Integer</IndExp>
<DatPal>DateTime</DatPal>
<HorPal>Integer</HorPal>
<TipInt>Integer</TipInt>
<IndPes>String</IndPes>
<UniFis>String</UniFis>
<UniEcf>String</UniEcf>
<CamposUsuarioUnidadeMedida>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuarioUnidadeMedida>
<Conversao>
<UniMed>String</UniMed>
<UniMe2>String</UniMe2>
<TipCnv>String</TipCnv>
<VlrCnv>Double</VlrCnv>
<CodReg>Integer</CodReg>
<CamposUsuarioConversao>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuarioConversao>
</Conversao>
</UnidadeDeMedida>
<MensagemRetorno>String</MensagemRetorno>
<FinalizaramRegistros>String</FinalizaramRegistros>
<NumeroLote>Integer</NumeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| Erros | Set | (Opcional) - Lista dos erros |
| Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
| TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| UnidadeDeMedida | Set | Lista de unidades de medida |
| UnidadeDeMedida.SeqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
| UnidadeDeMedida.UniMed | String | String(003) - Código da unidade de medida |
| UnidadeDeMedida.DesMed | String | String(010) - Descrição da unidade de medida |
| UnidadeDeMedida.QtdDec | Integer | Number(001) - Quantidade de decimais utilizada para a unidade de medida (Até 5) |
| UnidadeDeMedida.CodReg | Integer | Number(004) - Código da regra |
| UnidadeDeMedida.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para integração - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
| UnidadeDeMedida.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
| UnidadeDeMedida.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
| UnidadeDeMedida.TipInt | Integer | Number(001) - Tipo de Integração - [ 0=Incluído;1=Alterado;2=Em processo;3=Integrado;4=Aprovado/Incluído;5=Aprovado/Alterado ] |
| UnidadeDeMedida.IndPes | String | String(001) - Indicativo se no Varejo é obrigatória a pesagem do produto antes de - [ S=Sim;N=Não ] |
| UnidadeDeMedida.UniFis | String | String(006) - Unidade de medida fiscal |
| UnidadeDeMedida.UniEcf | String | String(002) - Unidade de medida para ECF |
| CamposUsuarioUnidadeMedida | Set | Lista de campos de usuário |
| CamposUsuarioUnidadeMedida.Campo | String | Nome do campo |
| CamposUsuarioUnidadeMedida.Valor | String | Valor do campo |
| Conversao | Set | Lista de conversões |
| Conversao.UniMed | String | String(003) - Unidade de medida da quantidade a ser convertida |
| Conversao.UniMe2 | String | String(003) - Unidade de medida para qual a quantidade será convertida |
| Conversao.TipCnv | String | String(001) - Operação de multiplicação () ou divisão (/) a ser utilizada na conversão - [ =Multiplicar;/=Dividir;R=Regra ] |
| Conversao.VlrCnv | Double | Number(013,6) - Valor para converter a "1ª Unidade Medida" para "2ª Unidade Medida" |
| Conversao.CodReg | Integer | Number(004) - Código da regra p/ formar conversão de uma Unidade Medida não atendidas pela conversão convencional |
| CamposUsuarioConversao | Set | Lista de campos de usuário |
| CamposUsuarioConversao.Campo | String | Nome do campo |
| CamposUsuarioConversao.Valor | String | Valor do campo |
| MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| FinalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| NumeroLote | Integer | Obrigatório - Inteiro - Identificação do Lote de Exportação |
| erroExecucao | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
ConsultarGeral
Nessa porta é possível obter uma coleção de dados através dos filtros disponíveis.
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:ConsultarGeral>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<UniMed>
<UniMed>String</UniMed>
</UniMed>
<CodEmp>Integer</CodEmp>
<UniFis>
<UniFis>String</UniFis>
</UniFis>
<CodFil>Integer</CodFil>
<IdentificadorSistema>String</IdentificadorSistema>
<IndicePagina>Integer</IndicePagina>
<LimitePagina>Integer</LimitePagina>
</parameters>
</ser:ConsultarGeral>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| UniMed | Set | (Opcional) - Lista de abrangência |
| UniMed.UniMed | String | (Opcional) - String(003) - Código da unidade de medida |
| CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| UniFis | Set | (Opcional) - Lista de abrangência |
| UniFis.UniFis | String | (Opcional) - String(006) - Unidade de medida fiscal |
| CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| IndicePagina | Integer | (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
| LimitePagina | Integer | (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
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:ConsultarGeralResponse>
<result>
<Erros>
<MensagemErro>String</MensagemErro>
</Erros>
<TipoRetorno>Integer</TipoRetorno>
<MensagemRetorno>String</MensagemRetorno>
<UnidadeDeMedida>
<UniMed>String</UniMed>
<DesMed>String</DesMed>
<QtdDec>Integer</QtdDec>
<CodReg>Integer</CodReg>
<IndExp>Integer</IndExp>
<DatPal>DateTime</DatPal>
<HorPal>Integer</HorPal>
<TipInt>Integer</TipInt>
<IndPes>String</IndPes>
<UniFis>String</UniFis>
<UniEcf>String</UniEcf>
<CamposUsuarioUnidadeMedida>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuarioUnidadeMedida>
<Conversao>
<UniMed>String</UniMed>
<UniMe2>String</UniMe2>
<TipCnv>String</TipCnv>
<VlrCnv>Double</VlrCnv>
<CodReg>Integer</CodReg>
<CamposUsuarioConversao>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuarioConversao>
</Conversao>
</UnidadeDeMedida>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarGeralResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| Erros | Set | (Opcional) - Lista dos erros |
| Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
| TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| UnidadeDeMedida | Set | Lista de unidades de medida |
| UnidadeDeMedida.UniMed | String | String(003) - Código da unidade de medida |
| UnidadeDeMedida.DesMed | String | String(010) - Descrição da unidade de medida |
| UnidadeDeMedida.QtdDec | Integer | Number(001) - Quantidade de decimais utilizada para a unidade de medida (Até 5) |
| UnidadeDeMedida.CodReg | Integer | Number(004) - Código da regra |
| UnidadeDeMedida.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para integração - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
| UnidadeDeMedida.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
| UnidadeDeMedida.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
| UnidadeDeMedida.TipInt | Integer | Number(001) - Tipo de Integração - [ 0=Incluído;1=Alterado;2=Em processo;3=Integrado;4=Aprovado/Incluído;5=Aprovado/Alterado ] |
| UnidadeDeMedida.IndPes | String | String(001) - Indicativo se no Varejo é obrigatória a pesagem do produto antes de - [ S=Sim;N=Não ] |
| UnidadeDeMedida.UniFis | String | String(006) - Unidade de medida fiscal |
| UnidadeDeMedida.UniEcf | String | String(002) - Unidade de medida para ECF |
| CamposUsuarioUnidadeMedida | Set | Lista de campos de usuário |
| CamposUsuarioUnidadeMedida.Campo | String | Nome do campo |
| CamposUsuarioUnidadeMedida.Valor | String | Valor do campo |
| Conversao | Set | Lista de conversões |
| Conversao.UniMed | String | String(003) - Unidade de medida da quantidade a ser convertida |
| Conversao.UniMe2 | String | String(003) - Unidade de medida para qual a quantidade será convertida |
| Conversao.TipCnv | String | String(001) - Operação de multiplicação () ou divisão (/) a ser utilizada na conversão - [ =Multiplicar;/=Dividir;R=Regra ] |
| Conversao.VlrCnv | Double | Number(013,6) - Valor para converter a "1ª Unidade Medida" para "2ª Unidade Medida" |
| Conversao.CodReg | Integer | Number(004) - Código da regra p/ formar conversão de uma Unidade Medida não atendidas pela conversão convencional |
| CamposUsuarioConversao | Set | Lista de campos de usuário |
| CamposUsuarioConversao.Campo | String | Nome do campo |
| CamposUsuarioConversao.Valor | String | Valor do campo |
| erroExecucao | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
English
Español
