Web service Com.senior.g5.co.cad.transportadora
O serviço de Transportadora é usado para permitir a exportação de registros com controle de integração utilizando a porta exportar. Esse mesmo serviço também conéem 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_cad_transportadora?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_cad_transportadora?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_cad_transportadora?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 "53" 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.
<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> <CodTra>String</CodTra> <CodFil>Integer</CodFil> <IdentificadorSistema>String</IdentificadorSistema> <QuantidadeRegistros>Integer</QuantidadeRegistros> <TipoIntegracao>String</TipoIntegracao> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodTra | String | (Opcional) - Number(009) - Código da transportadora |
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> <Transportadora> <SeqInt>Integer</SeqInt> <CodTra>Integer</CodTra> <NomTra>String</NomTra> <ApeTra>String</ApeTra> <TipTra>String</TipTra> <InsEst>String</InsEst> <InsMun>String</InsMun> <CgcCpf>Double</CgcCpf> <EndTra>String</EndTra> <CplEnd>String</CplEnd> <CepTra>Integer</CepTra> <BaiTra>String</BaiTra> <CidTra>String</CidTra> <SigUfs>String</SigUfs> <NomCto>String</NomCto> <FonTra>String</FonTra> <FaxTra>String</FaxTra> <CxaPst>Integer</CxaPst> <IntNet>String</IntNet> <CodVia>String</CodVia> <PlaVei>String</PlaVei> <CifFob>String</CifFob> <TraCli>Integer</TraCli> <TraFor>Integer</TraFor> <SitTra>String</SitTra> <PesMax>Double</PesMax> <VolMax>Double</VolMax> <CodGre>Integer</CodGre> <IndExp>Integer</IndExp> <DatPal>DateTime</DatPal> <HorPal>Integer</HorPal> <EenTra>String</EenTra> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> <PagCle>String</PagCle> <NenTra>String</NenTra> <NrnTrc>String</NrnTrc> <CodPai>String</CodPai> <VlrKmt>Double</VlrKmt> <ProTra>Integer</ProTra> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </Transportadora> <MensagemRetorno>String</MensagemRetorno> <FinalizaramRegistros>String</FinalizaramRegistros> <NumeroLote>Integer</NumeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
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 |
Transportadora | Set | Lista de transportadoras |
Transportadora.SeqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
Transportadora.CodTra | Integer | Number(009) - Código da Transportadora |
Transportadora.NomTra | String | String(100) - Nome da transportadora |
Transportadora.ApeTra | String | String(050) - Nome fantasia da transportadora |
Transportadora.TipTra | String | String(001) - Tipo de transportadora - [ J=Pessoa Jurídica;F=Pessoa Física ] |
Transportadora.InsEst | String | String(025) - Inscrição estadual da transportadora |
Transportadora.InsMun | String | String(016) - Inscrição municipal da transportadora |
Transportadora.CgcCpf | Double | Number(014) - Número do CNPJ ou CPF da transportadora |
Transportadora.EndTra | String | String(100) - Endereço da transportadora |
Transportadora.CplEnd | String | String(200) - Complemento do endereço da transportadora (sala, andar, etc.) |
Transportadora.CepTra | Integer | Number(008) - Cep da transportadora |
Transportadora.BaiTra | String | String(075) - Bairro da transportadora |
Transportadora.CidTra | String | String(060) - Cidade da transportadora |
Transportadora.SigUfs | String | String(002) - Sigla do estado da transportadora |
Transportadora.NomCto | String | String(150) - Nome da pessoa de contato na transportadora |
Transportadora.FonTra | String | String(020) - Número do telefone da transportadora |
Transportadora.FaxTra | String | String(020) - Número do FAX da transportadora |
Transportadora.CxaPst | Integer | Number(006) - Número da caixa postal da transportadora |
Transportadora.IntNet | String | String(100) - Endereço eletrônico (E-mail) |
Transportadora.CodVia | String | String(003) - Código da via de transporte da transportadora |
Transportadora.PlaVei | String | String(010) - Placa do veículo principal da transportadora |
Transportadora.CifFob | String | String(001) - Indicativo se o frete da transportadora é CIF ou FOB - [ C=Por conta do emitente (PAGO);F=Por conta do destinatário (A PAGAR);T=Por conta de terceiros;X=Sem frete ] |
Transportadora.TraCli | Integer | Number(009) - Código da transportadora como cliente |
Transportadora.TraFor | Integer | Number(009) - Código da transportadora como fornecedor |
Transportadora.SitTra | String | String(001) - Situação da transportadora - [ A=Ativo;I=Inativo ] |
Transportadora.PesMax | Double | Number(011,2) - Peso Máximo para frota própria |
Transportadora.VolMax | Double | Number(011,2) - Volume Máximo para Frota Própria |
Transportadora.CodGre | Integer | Number(004) - Código do grupo de empresas |
Transportadora.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
Transportadora.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
Transportadora.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
Transportadora.EenTra | String | String(018) - Código do endereço da transportadora |
Transportadora.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Transportadora.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Transportadora.HorGer | Integer | Number(005) - Hora da geração do registro |
Transportadora.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Transportadora.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Transportadora.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
Transportadora.PagCle | String | String(001) - Tipo de pagamento do serviço de coleta - [ K=Quilometragem;L=Litragem ] |
Transportadora.NenTra | String | String(060) - Número do endereço da transportadora |
Transportadora.NrnTrc | String | String(014) - Registro nacional de transportadores rodoviários de carga - RNTRC |
Transportadora.CodPai | String | String(004) - Código do país da transportadora |
Transportadora.VlrKmt | Double | Number(015,2) - Valor pago por quilômetro utilizado |
Transportadora.ProTra | Integer | Number(001) - Tipo proprietário - [ 0=TAC Agregado;1=TAC Independente;2=Outros ] |
CamposUsuario | Set | Lista de campos de usuário |
CamposUsuario.Campo | String | Nome do campo |
CamposUsuario.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" |
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.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarCadastro> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <SitTra>String</SitTra> <CodEmp>Integer</CodEmp> <CodTra> <CodTra>Integer</CodTra> </CodTra> <CodFil>Integer</CodFil> <CgcCpf> <CgcCpf>Double</CgcCpf> </CgcCpf> <IdentificadorSistema>String</IdentificadorSistema> <SigUfs> <SigUfs>String</SigUfs> </SigUfs> <IndicePagina>Integer</IndicePagina> <TipTra>String</TipTra> <LimitePagina>Integer</LimitePagina> </parameters> </ser:ConsultarCadastro> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
SitTra | String | (Opcional) - String(001) - Situação da transportadora |
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodTra | Set | (Opcional) - Lista de abrangência |
CodTra.CodTra | Integer | (Opcional) - Number(009) - Código da transportadora |
CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
CgcCpf | Set | (Opcional) - Lista de abrangência |
CgcCpf.CgcCpf | Double | (Opcional) - Number(014) - Número do CNPJ ou CPF da transportadora |
IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
SigUfs | Set | (Opcional) - Lista de abrangência |
SigUfs.SigUfs | String | (Opcional) - String(002) - Sigla do estado da transportadora |
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. |
TipTra | String | (Opcional) - String(001) - Tipo da transportadora |
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:ConsultarCadastroResponse> <result> <Erros> <MensagemErro>String</MensagemErro> </Erros> <TipoRetorno>Integer</TipoRetorno> <Transportadora> <CodTra>Integer</CodTra> <NomTra>String</NomTra> <ApeTra>String</ApeTra> <TipTra>String</TipTra> <InsEst>String</InsEst> <InsMun>String</InsMun> <CgcCpf>Double</CgcCpf> <EndTra>String</EndTra> <CplEnd>String</CplEnd> <CepTra>Integer</CepTra> <BaiTra>String</BaiTra> <CidTra>String</CidTra> <SigUfs>String</SigUfs> <NomCto>String</NomCto> <FonTra>String</FonTra> <FaxTra>String</FaxTra> <CxaPst>Integer</CxaPst> <IntNet>String</IntNet> <CodVia>String</CodVia> <PlaVei>String</PlaVei> <CifFob>String</CifFob> <TraCli>Integer</TraCli> <TraFor>Integer</TraFor> <SitTra>String</SitTra> <PesMax>Double</PesMax> <VolMax>Double</VolMax> <CodGre>Integer</CodGre> <IndExp>Integer</IndExp> <DatPal>DateTime</DatPal> <HorPal>Integer</HorPal> <EenTra>String</EenTra> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> <PagCle>String</PagCle> <NenTra>String</NenTra> <NrnTrc>String</NrnTrc> <CodPai>String</CodPai> <VlrKmt>Double</VlrKmt> <ProTra>Integer</ProTra> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </Transportadora> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarCadastroResponse> </soapenv:Body> </soapenv:Envelope>
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 |
Transportadora | Set | Lista de transportadoras |
Transportadora.CodTra | Integer | Number(009) - Código da Transportadora |
Transportadora.NomTra | String | String(100) - Nome da transportadora |
Transportadora.ApeTra | String | String(050) - Nome fantasia da transportadora |
Transportadora.TipTra | String | String(001) - Tipo de transportadora - [ J=Pessoa Jurídica;F=Pessoa Física ] |
Transportadora.InsEst | String | String(025) - Inscrição estadual da transportadora |
Transportadora.InsMun | String | String(016) - Inscrição municipal da transportadora |
Transportadora.CgcCpf | Double | Number(014) - Número do CNPJ ou CPF da transportadora |
Transportadora.EndTra | String | String(100) - Endereço da transportadora |
Transportadora.CplEnd | String | String(200) - Complemento do endereço da transportadora (sala, andar, etc.) |
Transportadora.CepTra | Integer | Number(008) - Cep da transportadora |
Transportadora.BaiTra | String | String(075) - Bairro da transportadora |
Transportadora.CidTra | String | String(060) - Cidade da transportadora |
Transportadora.SigUfs | String | String(002) - Sigla do estado da transportadora |
Transportadora.NomCto | String | String(150) - Nome da pessoa de contato na transportadora |
Transportadora.FonTra | String | String(020) - Número do telefone da transportadora |
Transportadora.FaxTra | String | String(020) - Número do FAX da transportadora |
Transportadora.CxaPst | Integer | Number(006) - Número da caixa postal da transportadora |
Transportadora.IntNet | String | String(100) - Endereço eletrônico (E-mail) |
Transportadora.CodVia | String | String(003) - Código da via de transporte da transportadora |
Transportadora.PlaVei | String | String(010) - Placa do veículo principal da transportadora |
Transportadora.CifFob | String | String(001) - Indicativo se o frete da transportadora é CIF ou FOB - [ C=Por conta do emitente (PAGO);F=Por conta do destinatário (A PAGAR);T=Por conta de terceiros;X=Sem frete ] |
Transportadora.TraCli | Integer | Number(009) - Código da transportadora como cliente |
Transportadora.TraFor | Integer | Number(009) - Código da transportadora como fornecedor |
Transportadora.SitTra | String | String(001) - Situação da transportadora - [ A=Ativo;I=Inativo ] |
Transportadora.PesMax | Double | Number(011,2) - Peso Máximo para frota própria |
Transportadora.VolMax | Double | Number(011,2) - Volume Máximo para Frota Própria |
Transportadora.CodGre | Integer | Number(004) - Código do grupo de empresas |
Transportadora.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
Transportadora.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
Transportadora.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
Transportadora.EenTra | String | String(018) - Código do endereço da transportadora |
Transportadora.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Transportadora.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Transportadora.HorGer | Integer | Number(005) - Hora da geração do registro |
Transportadora.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Transportadora.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Transportadora.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
Transportadora.PagCle | String | String(001) - Tipo de pagamento do serviço de coleta - [ K=Quilometragem;L=Litragem ] |
Transportadora.NenTra | String | String(060) - Número do endereço da transportadora |
Transportadora.NrnTrc | String | String(014) - Registro nacional de transportadores rodoviários de carga - RNTRC |
Transportadora.CodPai | String | String(004) - Código do país da transportadora |
Transportadora.VlrKmt | Double | Number(015,2) - Valor pago por quilômetro utilizado |
Transportadora.ProTra | Integer | Number(001) - Tipo proprietário - [ 0=TAC Agregado;1=TAC Independente;2=Outros ] |
CamposUsuario | Set | Lista de campos de usuário |
CamposUsuario.Campo | String | Nome do campo |
CamposUsuario.Valor | String | Valor do campo |
MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
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" |
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.
<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> <SitTra>String</SitTra> <CodEmp>Integer</CodEmp> <CodTra> <CodTra>Integer</CodTra> </CodTra> <CodFil>Integer</CodFil> <CgcCpf> <CgcCpf>Double</CgcCpf> </CgcCpf> <IdentificadorSistema>String</IdentificadorSistema> <SigUfs> <SigUfs>String</SigUfs> </SigUfs> <IndicePagina>Integer</IndicePagina> <TipTra>String</TipTra> <LimitePagina>Integer</LimitePagina> </parameters> </ser:ConsultarGeral> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
SitTra | String | (Opcional) - String(001) - Situação da transportadora |
CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
CodTra | Set | (Opcional) - Lista de abrangência |
CodTra.CodTra | Integer | (Opcional) - Number(009) - Código da transportadora |
CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
CgcCpf | Set | (Opcional) - Lista de abrangência |
CgcCpf.CgcCpf | Double | (Opcional) - Number(014) - Número do CNPJ ou CPF da transportadora |
IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
SigUfs | Set | (Opcional) - Lista de abrangência |
SigUfs.SigUfs | String | (Opcional) - String(002) - Sigla do estado da transportadora |
IndicePagina | Integer | (Opcional) - Number - Deslocamento que determina o índice da primeira requisição a ser retornada. Exemplo: se o valor de deslocamento for 3, somente serão retornados dados da terceira requisição em diante. Observação 1: o primeiro registro é considerado com deslocamento 1. Observação 2: quando não informado ou com valor "0" ou "1", é retornado a partir do primeiro registro. |
TipTra | String | (Opcional) - String(001) - Tipo da transportadora |
LimitePagina | Integer | (Opcional) - Number - Quantidade máxima de registros a ser retornada. Observação 1: quando não informado ou com valor "0", sistema define automaticamente máximo de 100 registros. |
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> <Transportadora> <CodTra>Integer</CodTra> <NomTra>String</NomTra> <ApeTra>String</ApeTra> <TipTra>String</TipTra> <InsEst>String</InsEst> <InsMun>String</InsMun> <CgcCpf>Double</CgcCpf> <EndTra>String</EndTra> <CplEnd>String</CplEnd> <CepTra>Integer</CepTra> <BaiTra>String</BaiTra> <CidTra>String</CidTra> <SigUfs>String</SigUfs> <NomCto>String</NomCto> <FonTra>String</FonTra> <FaxTra>String</FaxTra> <CxaPst>Integer</CxaPst> <IntNet>String</IntNet> <CodVia>String</CodVia> <PlaVei>String</PlaVei> <CifFob>String</CifFob> <TraCli>Integer</TraCli> <TraFor>Integer</TraFor> <SitTra>String</SitTra> <PesMax>Double</PesMax> <VolMax>Double</VolMax> <CodGre>Integer</CodGre> <IndExp>Integer</IndExp> <DatPal>DateTime</DatPal> <HorPal>Integer</HorPal> <EenTra>String</EenTra> <UsuGer>Double</UsuGer> <DatGer>DateTime</DatGer> <HorGer>Integer</HorGer> <UsuAlt>Double</UsuAlt> <DatAlt>DateTime</DatAlt> <HorAlt>Integer</HorAlt> <PagCle>String</PagCle> <NenTra>String</NenTra> <NrnTrc>String</NrnTrc> <CodPai>String</CodPai> <VlrKmt>Double</VlrKmt> <ProTra>Integer</ProTra> <CamposUsuario> <Campo>String</Campo> <Valor>String</Valor> </CamposUsuario> </Transportadora> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarGeralResponse> </soapenv:Body> </soapenv:Envelope>
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 |
Transportadora | Set | Lista de transportadoras |
Transportadora.CodTra | Integer | Number(009) - Código da Transportadora |
Transportadora.NomTra | String | String(100) - Nome da transportadora |
Transportadora.ApeTra | String | String(050) - Nome fantasia da transportadora |
Transportadora.TipTra | String | String(001) - Tipo de transportadora - [ J=Pessoa Jurídica;F=Pessoa Física ] |
Transportadora.InsEst | String | String(025) - Inscrição estadual da transportadora |
Transportadora.InsMun | String | String(016) - Inscrição municipal da transportadora |
Transportadora.CgcCpf | Double | Number(014) - Número do CNPJ ou CPF da transportadora |
Transportadora.EndTra | String | String(100) - Endereço da transportadora |
Transportadora.CplEnd | String | String(200) - Complemento do endereço da transportadora (sala, andar, etc.) |
Transportadora.CepTra | Integer | Number(008) - Cep da transportadora |
Transportadora.BaiTra | String | String(075) - Bairro da transportadora |
Transportadora.CidTra | String | String(060) - Cidade da transportadora |
Transportadora.SigUfs | String | String(002) - Sigla do estado da transportadora |
Transportadora.NomCto | String | String(150) - Nome da pessoa de contato na transportadora |
Transportadora.FonTra | String | String(020) - Número do telefone da transportadora |
Transportadora.FaxTra | String | String(020) - Número do FAX da transportadora |
Transportadora.CxaPst | Integer | Number(006) - Número da caixa postal da transportadora |
Transportadora.IntNet | String | String(100) - Endereço eletrônico (E-mail) |
Transportadora.CodVia | String | String(003) - Código da via de transporte da transportadora |
Transportadora.PlaVei | String | String(010) - Placa do veículo principal da transportadora |
Transportadora.CifFob | String | String(001) - Indicativo se o frete da transportadora é CIF ou FOB - [ C=Por conta do emitente (PAGO);F=Por conta do destinatário (A PAGAR);T=Por conta de terceiros;X=Sem frete ] |
Transportadora.TraCli | Integer | Number(009) - Código da transportadora como cliente |
Transportadora.TraFor | Integer | Number(009) - Código da transportadora como fornecedor |
Transportadora.SitTra | String | String(001) - Situação da transportadora - [ A=Ativo;I=Inativo ] |
Transportadora.PesMax | Double | Number(011,2) - Peso Máximo para frota própria |
Transportadora.VolMax | Double | Number(011,2) - Volume Máximo para Frota Própria |
Transportadora.CodGre | Integer | Number(004) - Código do grupo de empresas |
Transportadora.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
Transportadora.DatPal | DateTime | Date(DD/MM/YYYY) - Data da última alteração para o Palmtop |
Transportadora.HorPal | Integer | Number(005) - Hora/minuto da última alteração para o Palm |
Transportadora.EenTra | String | String(018) - Código do endereço da transportadora |
Transportadora.UsuGer | Double | Number(010) - Usuário responsável pela geração do registro |
Transportadora.DatGer | DateTime | Date(DD/MM/YYYY) - Data da geração do registro |
Transportadora.HorGer | Integer | Number(005) - Hora da geração do registro |
Transportadora.UsuAlt | Double | Number(010) - Usuário responsável pela última alteração do registro |
Transportadora.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da última alteração do registro |
Transportadora.HorAlt | Integer | Number(005) - Hora da última alteração do registro |
Transportadora.PagCle | String | String(001) - Tipo de pagamento do serviço de coleta - [ K=Quilometragem;L=Litragem ] |
Transportadora.NenTra | String | String(060) - Número do endereço da transportadora |
Transportadora.NrnTrc | String | String(014) - Registro nacional de transportadores rodoviários de carga - RNTRC |
Transportadora.CodPai | String | String(004) - Código do país da transportadora |
Transportadora.VlrKmt | Double | Number(015,2) - Valor pago por quilômetro utilizado |
Transportadora.ProTra | Integer | Number(001) - Tipo proprietário - [ 0=TAC Agregado;1=TAC Independente;2=Outros ] |
CamposUsuario | Set | Lista de campos de usuário |
CamposUsuario.Campo | String | Nome do campo |
CamposUsuario.Valor | String | Valor do campo |
MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
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" |