English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.cad.familiaparametros
Web service Com.senior.g5.co.cad.familiaparametros
Na porta Consultar geral é possível obter uma coleção de dados através dos filtros disponíveis.
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.familiaparametros?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom.senior.g5.co.cad.familiaparametros?wsdl
- Agendamento: http://example.com/g5-senior-services/sapiens_Schedulecom.senior.g5.co.cad.familiaparametros?wsdl
Porta
Consultar
Necessita autenticação: Sim
Situação da versão: Atual
Versão: 1
Versão atual: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Consultar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<CodFam>
<CodFam>String</CodFam>
</CodFam>
<CodEmp>Integer</CodEmp>
<CodFil>Integer</CodFil>
<IdentificadorSistema>String</IdentificadorSistema>
<IndicePagina>Integer</IndicePagina>
<LimitePagina>Integer</LimitePagina>
</parameters>
</ser:Consultar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Descrição |
|---|---|---|---|
| CodFam | Set | Opcional | (Opcional) - Lista de abrangência |
| CodFam.CodFam | String | Opcional | (Opcional) - String(006) - Código da família do produto |
| CodEmp | Integer | Obrigatório | (Obrigatório) - Number(004) - Código da Empresa |
| 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 |
| IndicePagina | Integer | Opcional | (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 | (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:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ConsultarResponse>
<result>
<Erros>
<MensagemErro>String</MensagemErro>
</Erros>
<TipoRetorno>Integer</TipoRetorno>
<MensagemRetorno>String</MensagemRetorno>
<ParametrosFamilia>
<CodFam>String</CodFam>
<MoeOsc>String</MoeOsc>
<PerOsc>Double</PerOsc>
<UsuGer>Double</UsuGer>
<DatGer>DateTime</DatGer>
<HorGer>Integer</HorGer>
<UsuAtu>Double</UsuAtu>
<DatAtu>DateTime</DatAtu>
<HorAtu>Integer</HorAtu>
<PreMin>Double</PreMin>
<CamposUsuario>
<Campo>String</Campo>
<Valor>String</Valor>
</CamposUsuario>
</ParametrosFamilia>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| erros | Set | Opcional | (Opcional) - Lista dos erros |
| erros.mensagemErro | String | Opcional | (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 | (Obrigatório) - String (1000) - Mensagem de Retorno de Processamento |
| ParametrosFamilia | Set | Opcional | Lista de Parâmetros da Família |
| ParametrosFamilia.CodFam | String | Opcional | String(006) - Código da Família do Produto |
| ParametrosFamilia.MoeOsc | String | Opcional | String(003) - Código da moeda padrão para ordens de compra sem contrato de participantes e NF de depósito |
| ParametrosFamilia.PerOsc | Double | Opcional | Number(005,2) - Percentual da moeda padrão para geração das NFs de depósito |
| ParametrosFamilia.UsuGer | Double | Opcional | Number(010) - Usuário responsável pela geração do registro |
| ParametrosFamilia.DatGer | DateTime | Opcional | Date(DD/MM/YYYY) - Data da geração do registro |
| ParametrosFamilia.HorGer | Integer | Opcional | Number(005) - Hora da geração do registro |
| ParametrosFamilia.UsuAtu | Double | Opcional | Number(010) - Usuário responsável pela última atualização |
| ParametrosFamilia.DatAtu | DateTime | Opcional | Date(DD/MM/YYYY) - Data da última atualização do cadastro |
| ParametrosFamilia.HorAtu | Integer | Opcional | Number(005) - Hora/minuto da última atualização do cadastro |
| ParametrosFamilia.PreMin | Double | Opcional | Number(009,5) - Preço Mínimo para Compra |
| CamposUsuario | Set | Opcional | Campo de usuário |
| CamposUsuario.Campo | String | Opcional | Campo de usuário |
| CamposUsuario.Valor | String | Opcional | Campo de usuário |
| 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
