Web service Com.senior.g5.co.ger.cad.propriedadeSubpropriedade
O serviço de propriedades e subpropriedades é 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.
- 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
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.
- 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
- 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_ger_cad_propriedadeSubpropriedade?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_propriedadeSubpropriedade?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_ger_cad_propriedadeSubpropriedade?wsdl
Portas
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 "159" para retornar ao ERP a confirmação de recebimento dos registros, executando o web service com.senior.g5.co.int.geral.exportacao.Confirmar.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<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> <CodCli>Integer</CodCli> <CodFil>Integer</CodFil> <IdentificadorSistema>String</IdentificadorSistema> <QuantidadeRegistros>Integer</QuantidadeRegistros> <TipoIntegracao>String</TipoIntegracao> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodCli | Integer | (Opcional) - Number(009) - Código do cliente |
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 |
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> <Propriedades> <SeqInt>Integer</SeqInt> <CodCli>Integer</CodCli> <CodPrp>Integer</CodPrp> <NomPrp>String</NomPrp> <ArrPrp>String</ArrPrp> <TipArp>Integer</TipArp> <CliPrp>Integer</CliPrp> <ObsPrp>String</ObsPrp> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> </Propriedades> <Subpropriedades> <CodCli>Integer</CodCli> <CodPrp>Integer</CodPrp> <CodSpr>Integer</CodSpr> <NomSpr>String</NomSpr> <ArrPrp>String</ArrPrp> <TipArp>Integer</TipArp> <ObsPrp>String</ObsPrp> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> </Subpropriedades> <MensagemRetorno>String</MensagemRetorno> <FinalizaramRegistros>String</FinalizaramRegistros> <NumeroLote>Integer</NumeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
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 |
Propriedades | Set | Lista de propriedades |
Propriedades.SeqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
Propriedades.CodCli | Integer | Number(009) - Código do Cliente |
Propriedades.CodPrp | Integer | Number(009) - Código da propriedade |
Propriedades.NomPrp | String | String(100) - Nome da propriedade |
Propriedades.ArrPrp | String | String(001) - Indicativo de arrendamento da propriedade - [ S=Sim;N=Não ] |
Propriedades.TipArp | Integer | Number(001) - Tipo do Arrendamento da Propriedade - [ 1=Cedido;2=Recebido ] |
Propriedades.CliPrp | Integer | Number(009) - Código do cliente que representa a propriedade |
Propriedades.ObsPrp | String | String(1999) - Observações da propriedade |
Propriedades.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Propriedades.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Propriedades.HorGer | Integer | Number(005) - Hora da geração do registro |
Propriedades.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Propriedades.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Propriedades.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
Subpropriedades | Set | Lista de subpropriedades |
Subpropriedades.CodCli | Integer | Number(009) - Código do Cliente |
Subpropriedades.CodPrp | Integer | Number(009) - Código da propriedade |
Subpropriedades.CodSpr | Integer | Number(009) - Código da Subpropriedade |
Subpropriedades.NomSpr | String | String(100) - Nome da Subpropriedade |
Subpropriedades.ArrPrp | String | String(001) - Indicativo de arrendamento da propriedade - [ S=Sim;N=Não ] |
Subpropriedades.TipArp | Integer | Number(001) - Tipo do Arrendamento da Propriedade - [ 1=Cedido;2=Recebido ] |
Subpropriedades.ObsPrp | String | String(1999) - Observações da Subpropriedade |
Subpropriedades.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Subpropriedades.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Subpropriedades.HorGer | Integer | Number(005) - Hora da geração do registro |
Subpropriedades.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Subpropriedades.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Subpropriedades.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
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 sucesso; - A mensagem do erro ocorrido no servidor. |
Esta porta tem a finalidade de somente retornar os registros da consulta.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<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> <CodEmp>Integer</CodEmp> <CodPrp> <CodPrp>String</CodPrp> </CodPrp> <CodFil>Integer</CodFil> <CodCli> <CodCli>Integer</CodCli> </CodCli> <IdentificadorSistema>String</IdentificadorSistema> <IndicePagina>Integer</IndicePagina> <LimitePagina>Integer</LimitePagina> </parameters> </ser:ConsultarGeral> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodPrp | Set | (Opcional) - Lista de abrangência |
CodPrp.CodPrp | String | (Opcional) - Número(009) - Código da propriedade |
CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
CodCli | Set | (Opcional) - Lista de abrangência |
CodCli.CodCli | Integer | (Opcional) - Número(009) - Código do cliente |
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. |
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> <MensagemRetorno>String</MensagemRetorno> <Propriedades> <CodCli>Integer</CodCli> <CodPrp>Integer</CodPrp> <NomPrp>String</NomPrp> <ArrPrp>String</ArrPrp> <TipArp>Integer</TipArp> <CliPrp>Integer</CliPrp> <ObsPrp>String</ObsPrp> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> </Propriedades> <Subpropriedades> <CodCli>Integer</CodCli> <CodPrp>Integer</CodPrp> <CodSpr>Integer</CodSpr> <NomSpr>String</NomSpr> <ArrPrp>String</ArrPrp> <TipArp>Integer</TipArp> <ObsPrp>String</ObsPrp> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> </Subpropriedades> <TipoRetorno>Integer</TipoRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarGeralResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
Erros | Set | (Opcional) - Lista dos erros |
Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
Propriedades | Set | Lista de propriedades |
Propriedades.CodCli | Integer | Number(009) - Código do Cliente |
Propriedades.CodPrp | Integer | Number(009) - Código da propriedade |
Propriedades.NomPrp | String | String(100) - Nome da propriedade |
Propriedades.ArrPrp | String | String(001) - Indicativo de arrendamento da propriedade - [ S=Sim;N=Não ] |
Propriedades.TipArp | Integer | Number(001) - Tipo do Arrendamento da Propriedade - [ 1=Cedido;2=Recebido ] |
Propriedades.CliPrp | Integer | Number(009) - Código do cliente que representa a propriedade |
Propriedades.ObsPrp | String | String(1999) - Observações da propriedade |
Propriedades.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Propriedades.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Propriedades.HorGer | Integer | Number(005) - Hora da geração do registro |
Propriedades.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Propriedades.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Propriedades.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
Subpropriedades | Set | Lista de subpropriedades |
Subpropriedades.CodCli | Integer | Number(009) - Código do Cliente |
Subpropriedades.CodPrp | Integer | Number(009) - Código da propriedade |
Subpropriedades.CodSpr | Integer | Number(009) - Código da Subpropriedade |
Subpropriedades.NomSpr | String | String(100) - Nome da Subpropriedade |
Subpropriedades.ArrPrp | String | String(001) - Indicativo de arrendamento da propriedade - [ S=Sim;N=Não ] |
Subpropriedades.TipArp | Integer | Number(001) - Tipo do Arrendamento da Propriedade - [ 1=Cedido;2=Recebido ] |
Subpropriedades.ObsPrp | String | String(1999) - Observações da Subpropriedade |
Subpropriedades.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Subpropriedades.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Subpropriedades.HorGer | Integer | Number(005) - Hora da geração do registro |
Subpropriedades.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Subpropriedades.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Subpropriedades.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitaçã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 sucesso; - A mensagem do erro ocorrido no servidor. |