English
Español
Web service Com.senior.g5.co.ger.cad.tipoveiculo
Este web service permite importar ou excluir os dados de tipo de veículos.
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.
Acesse a listagem de Classes dos web services para consultar as portas/operações disponíveis e as classes responsáveis pela execução das rotinas de integração.
WSDL
- Síncrono: `http://servidor:1234/g5-senior-services/sapiens_Synccom_senior_g5_co_ger_cad_tipoveiculo?wsdl`
- Assíncrono: `http://servidor:1234/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_tipoveiculo?wsdl`
- Agendado: `http://servidor:1234/g5-senior-services/sapiens_Schedulecom_senior_g5_co_ger_cad_tipoveiculo?wsdl`
Portas
Importar
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:Importar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<TipoVeiculo>
<codTip>Integer</codTip>
<desTip>String</desTip>
<abrTip>String</abrTip>
<sitTip>String</sitTip>
<vlrDia>Double</vlrDia>
</TipoVeiculo>
</parameters>
</ser:Importar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Ajuda |
|---|---|---|
| tipoVeiculo | Set | Lista de tipos de veículos |
| tipoVeiculo.codTip | Integer | Number(004) - Código do tipo de veículo |
| tipoVeiculo.desTip | String | String(030) - Descrição do tipo de veículo |
| tipoVeiculo.abrTip | String | String(010) - Abreviatura do tipo de veículo |
| tipoVeiculo.sitTip | String | String(001) - Situação do registro - [ A=Ativo;I=Inativo ] |
| tipoVeiculo.vlrDia | Double | Number(015,2) - Valor da diária paga ao motorista |
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:ImportarResponse>
<result>
<Retornos>
<codTip>Integer</codTip>
<tipoRetorno>String</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
</Retornos>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:| Nome | Tipo | Ajuda |
|---|---|---|
| retorno | Set | Lista de tipos de veículos |
| retorno.codTip | Integer | Number(004) - Código do tipo de veículo |
| retorno.tipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| retorno.mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| 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 sucesso; - A mensagem do erro ocorrido no servidor. |
Excluir
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:Excluir>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<TipoVeiculo>
<codTip>Integer</codTip>
</TipoVeiculo>
</parameters>
</ser:Excluir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Ajuda |
|---|---|---|
| tipoVeiculo | Set | Lista de tipos de veículos |
| tipoVeiculo.codTip | Integer | Number(004) - Código do tipo de veículo |
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:ExcluirResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<Retorno>
<codTip>Integer</codTip>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
</Retorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExcluirResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:| Nome | Tipo | Ajuda |
|---|---|---|
| tipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| retorno | Set | Lista de tipos de veículos |
| retorno.codTip | Integer | Number(004) - Código do tipo de veículo |
| retorno.tipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
| retorno.mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| 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 sucesso; - A mensagem do erro ocorrido no servidor. |
English
Español
