Controle de reservas - Webservices

Introdução

Os serviços a seguir estão disponíveis (webservices/wsReserva.asmx) para gerenciar o controle de reservas. São eles:

ExcluirReserva
ConsultarDadosControleReserva
ConsultarReservaPorCodigo
ConsultarReservas
ConsultaReservaPorProposta
ConsultarReservaVendedor
GravarReserva

Webservices

As informações sobre cada serviço obedecem a seguinte estrutura: breve descrição de sua funcionalidade, parâmetros de entrada, retorno e regras.

Excluir

ExcluirReserva – exclui a reserva escolhida e sua taxa caso possua
Parâmetros de entrada
CodEmpresa Integer Código da empresa

Obra String Código da obra

NumProposta Integer Número da proposta

CodProd Integer Código do produto

CodPerson Integer Código da personalização

CodReserva Integer Codígo da reserva
Retorno
Objeto do tipo ResultadoExecucao que contém as informações do resultado da execução da rotina.

Sucesso: Propriedade do tipo boolean que identifica o resultado da execução.
Mensagem: Propriedade do tipo string que contém informações a respeito do erro gerado na execução da rotina.

Regras
A exclusão só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de exclusão no programa (OBRESERVA)
A data de lançamento no controle financeiro será testada para fechamento de caixa contábil.

Consultar

ConsultarDadosControleReserva – Retorna os dados do controle de reserva da personalização informada.
Parâmetros de entrada

CodEmpresa Integer Código da empresa

CodProduto Integer Código do produto

CodPerson Integer Código da personalização

Status String Status da reserva (1 – Reservas ativas; 5 – Reservas ativas e confirmadas; 6 – Fila de reserva da unidade personalizada)

Retorno

Objeto do tipo DataSet com as tabelas a seguir:

Tabela Reserva:

Num_rsv Integer Número da reserva
NumProd_rsv Integer Número do produto
Empresa_rsv Short Código da empresa
NumPer_rsv Integer Número da personalização
DataCad_rsv DateTime Data de cadastro da reversa
Vendedor_rsv Integer Código do vendedor
TempoIndet_rsv Short Tempo Indeterminado para reserva
Status_rsv Short Status da reserva

Tabela PrdSrv:
Descricao_psc Varchar Descrição do produto

Tabela Empresas:
Desc_emp Varchar Descrição da empresa

Tabela Pessoas:
Nome_pes Varchar Nome do cliente

Validações
A consulta só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de consultar no programa (OBRESERVA)

Exemplo segue o link: //200.178.248.104:86/portaluautestes/wsReserva.asmx?op=ConsultarDadosControleReserva

ConsultarReservas – Retorna os dados do controle de reserva da personalização, que possuem o status informado
Parâmetros de entrada

CodEmpresa Integer Código da empresa

CodProduto Integer Código do produto

CodPerson Integer Código da personalização

Status String Status da reserva (1 – Reservas ativas; 5 – Reservas ativas e confirmadas; 6 – Fila de reserva da unidade personalizada)

Retorno
Objeto do tipo DataSet com as tabelas a seguir:

Tabela Reserva:

Empresa_rsv Short Código da empresa
NumProd_rsv Integer Número do produto
NumPer_rsv Integer Número da personalização
Num_rsv Integer Número da reserva
CodDvg_rsv Integer Código da divulgação
Vendedor_rsv Integer Código do vendedor
Login_rsv String Usuário que lançou a reserva
Data_rsv DateTime Data da reserva
Periodo_rsv Integer Período de validade, em horas, da reserva
Cliente_rsv String Nome do cliente que reservou
Fone_rsv String Telefone para contato
TempoIndet_rsv Short Se a reserva possui tempo indeterminado: 0 ou 1
Status_rsv Short Status da reserva:
NumProposta_rsv Integer Número da proposta de venda
DataConfir_rsv DateTime Data de confirmação reserva ativa confirmada
UsrConfir_rsv String Usuário que confirmou reserva ativa confirmada
UsrCancel_rsv String Usuário que cancelou a reserva
DataCancel_rsv DateTime Data do cancelamento
Anexos_rsv Tinyint Indicar os tipos de Anexos de um registro (Pendencia, Comentario ou foto)
NumConf_rsv Integer Código de reserva confirmada sequencial.
CodPesConfir_rsv Integer Código da pessoa que solicitou a confirmação da reserva.
GeraTaxaReserva_rsv Byte Se irá gerar taxa de reserva: 0-Não gera taxa; 1- gera taxa
ValReserva_rsv Double Valor da reserva
ReservaPaga_rsv Byte Se a taxa de reserva foi paga pelo cliente: 0-Não foi paga; 1-foi paga pelo cliente
Banco_rsv Short Código do banco
Conta_rsv String Número da conta
NumEs_rsv Integer É o numero da entrada/saída – sequencial
EntSai_rsv Short Tipo que define: 0-Entrada 1-Saída
DataCad_rsv DateTime Data de cadastro da reserva ou o cadastro da reserva na fila de reserva.

Tabela EntSaiEmpAplic:

Data_es DateTime Data de lançamento de controle financeiro
Valor_es Double Valor da taxa
Natureza_es String Natureza dos lançamentos ex: principal, taxa, juros, impostos etc
Cap_es String Código de apropriação custo/contabilidade
MesPL_es DateTime Mês de planejamento incidente (Mês/ano)
NumDoc_es String Numero do documento (no. do cheque caso emissao_ent=0)
Emissao_es String Define o tipo de emissão cheque , dinheiro, debito c/c, credito c/c
HistLanc_es String Histórico do lançamento contábil
CategMovFin_es String Código da categoria de movimentação financeira
NumAplic_es Integer Número da aplicação financeira
StatusAplic_es Short Define se o lançamento está ativo ou não
NumSeq_es Integer Identificar os blocos das operações de aplicação;
DataCad_es DateTime Data de cadastro
Obra_es String Obra em que esta sendo feito o Empréstimo ou Aplicação
LancManual String Quem fez o lançamento da entrada/saída

Tabela Banco:

Nome_banco Varchar(20) Nome do banco

Tabela CCorrente:

Descri_banco Varchar(50) Descrição da conta corrente

Tabela CategoriasDeMovFin:

Desc_cmf Varchar(50) Descrição da categoria de movimentação financeira

Tabela CAP:

Desc_cgerCAP Varchar(50) Descrição do CAP

Tabela CategoriasDeTipoDeMovimentacao:

Desc_cgerCateg Varchar(50) Descrição da categoria do tipo de movimentação

Validações
A consulta só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de consultar no programa (OBRESERVA)

Exemplo segue o link: //200.178.248.104:86/portaluautestes/webservices/wsReserva.asmx?op=ConsultarReservas

ConsultarReservaPorCodigo- Retorna os dados do controle de reserva da personalização, que possuem o código da reserva informado.
Parâmetros de entrada

CodEmpresa Integer Código da empresa

CodProduto Integer Código do produto

CodPerson Integer Código da personalização

CodReserva Integer Número da reserva

Retorno
Objeto do tipo DataSet com as tabelas a seguir:

Tabela Reserva:

Tabela EntSaiEmpAplic:

Tabela Banco:

Nome_banco Varchar(20) Nome do banco

Tabela CCorrente:

Descri_banco Varchar(50) Descrição da conta corrente

Tabela CategoriasDeMovFin:

Desc_cmf Varchar(50) Descrição da categoria de movimentação financeira

Tabela CAP:

Desc_cgerCAP Varchar(50) Descrição do CAP

Tabela CategoriasDeTipoDeMovimentacao:

Desc_cgerCateg Varchar(50) Descrição da categoria do tipo de movimentação

Validações
A consulta só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de consulta no programa (OBRESERVA)

Exemplo segue o link: //200.178.248.104:86/portaluautestes/webservices/wsReserva.asmx?op=ConsultarReservaPorCodigo

ConsultaReservaPorProposta- Retorna os dados do controle de reserva da personalização, que possuem o número da proposta informado.
Parâmetros de entrada

CodEmpresa Integer Código da empresa

Obra String Código do obra

NumProposta Integer Número da proposta.

Retorno
Objeto do tipo DataSet com as tabelas a seguir:

Tabela Reserva:

Validações
A consulta só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de consultar no programa (OBRESERVA)

Exemplo segue o link: //200.178.248.104:86/portaluautestes/webservices/wsReserva.asmx?op=ConsultaReservaPorProposta

ConsultarReservaVendedor- Retorna os dados do controle de reserva da personalização, que possuem o código do vendedor informado
Parâmetros de entrada

Empresa Short Código da empresa

NumProd Integer Número do produto

NumPer Integer Número da personalização

Vendedor Integer Código do vendedor.

Retorno
Objeto do tipo DataSet com as tabelas a seguir:

Tabela Reserva:

Validações:
A consulta só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de consultar no programa (OBRESERVA)

Exemplo segue o link: //200.178.248.104:86/portaluautestes/webservices/wsReserva.asmx?op=ConsultarReservaVendedor

Gravar

GravarReserva – insere/altera informações sobre a reserva.
Parâmetros de entrada
Objeto do tipo DataSet. Este possui 2 tabelas: Reserva e taxa.

Tabela Reserva:

Empresa_rsv Short Código da empresa
NumProd_rsv Integer Número do produto
NumPer_rsv Integer Número da personalização
Num_rsv Integer Número da reserva
CodDvg_rsv Integer Código da divulgação
Vendedor_rsv Integer Código do vendedor
Login_rsv String Usuário que lançou a reserva
Data_rsv DateTime Data da reserva
Periodo_rsv Integer Período de validade, em horas, da reserva
Cliente_rsv String Nome do cliente que reservou
Fone_rsv String Telefone para contato
TempoIndet_rsv Short Se a reserva possui tempo indeterminado: 0 ou 1
Status_rsv Short Status da reserva:
NumProposta_rsv Integer Número da proposta de venda
DataConfir_rsv DateTime Data de confirmação reserva ativa confirmada
UsrConfir_rsv String Usuário que confirmou reserva ativa confirmada
UsrCancel_rsv String Usuário que cancelou a reserva
DataCancel_rsv DateTime Data do cancelamento
NumConf_rsv Integer Código de reserva confirmada sequencial.
CodPesConfir_rsv Integer Código da pessoa que solicitou a confirmação da reserva.
GeraTaxaReserva_rsv Byte Se irá gerar taxa de reserva: 0-Não gera taxa; 1- gera taxa
ValReserva_rsv Double Valor da reserva
ReservaPaga_rsv Byte Se a taxa de reserva foi paga pelo cliente: 0-Não foi paga; 1-foi paga pelo cliente
Banco_rsv Short Código do banco
Conta_rsv String Número da conta
NumEs_rsv Integer É o numero da entrada/saída – sequencial
EntSai_rsv Short Tipo que define: 0-Entrada 1-Saída
DataCad_rsv DateTime Data de cadastro da reserva ou o cadastro da reserva na fila de reserva.

Tabela taxa:

Empresa_es Short Código da empresa
Banco_es Short Numero do banco da operação
Conta_es String Número da conta
Num_es Integer Número do lançamento de controle financeiro
EntSai_es Short Tipo que define: 0-Entrada 1-Saída
Obra_es String Obra em que esta sendo feito o Empréstimo ou Aplicação
Data_es DateTime Data de lançamento de controle financeiro
Usuario_es String Quem fez o lançamento da entrada/saída
Valor_es Double Valor da taxa
Natureza_es String Natureza dos lançamentos ex: principal, taxa, juros, impostos etc
Cap_es String Código de apropriação custo/contabilidade
MesPL_es DateTime Mês de planejamento incidente (Mês/ano)
NumDoc_es String Numero do documento (no. do cheque caso emissao_ent=0)
Emissao_es String Define o tipo de emissão cheque , dinheiro, debito c/c, credito c/c
HistLanc_es String Histórico do lançamento contábil
CategMovFin_es String Código da categoria de movimentação financeira
NumAplic_es Integer Número da aplicação financeira
StatusAplic_es Short Define se o lançamento está ativo ou não
NumSeq_es Integer Identificar os blocos das operações de aplicação;
DataCad_es DateTime Data de cadastro

Retorno
Objeto do tipo ResultadoExecucao que contém as informações do resultado da execução da rotina.

Sucesso: Propriedade do tipo boolean que identifica o resultado da execução.
Mensagem: Propriedade do tipo string que contém informações a respeito do erro gerado na execução da rotina.

Regras
A gravação só será feita desde que satisfeitas as seguintes condições:

Usuário deve estar autenticado.
Deve possuir permissão de inclusão/Alteração no programa (OBRESERVA)
A reserva só pode ser feita para unidades do tipo igual a 0 – Disponível e 2 – Reservado
Taxa de reserva somente para unidades com tipo de contrato igual a 1 – Aluguel , 2 – Aluguel garantido e 5– Aluguel shopping.
Sobre fila de reserva:
1. Para inserir uma reserva na fila deve está configurado para Habilitar fila de reserva na tela “Cadastro de Obras” aba “Venda” no modulo Obras.
2. Não é possível inserir uma reserva na fila se existir uma reserva ativa confirmada para essa personalização desse produto.
Não é possível inserir uma reserva com status 1 – Ativa se existir uma reserva ativa confirmada ou ativa para essa personalização desse produto.
Não é possível inserir uma reserva Ativa confirmada se existir uma reserva ativa confirmada para essa personalização desse produto.
O mesmo vendedor pode inserir uma quantidade x consecutiva de reservas, para isso deve está configurado para “Número de reservas consecutivas do mesmo vendedor” na na tela “Cadastro de Obras” aba “Venda” no modulo Obras. Caso o vendedor ultrapasse esta quantidade o sistema gera um alerta informado que: “O mesmo vendedor não pode inserir uma quantidade consecutiva de reservas maior que a permitida”.
O mesmo vendedor não pode inserir uma nova reserva se o prazo de espera for menor que o prazo permitido e se nenhum outro vendedor tiver realizado uma nova reserva.
Se tiver informado número da proposta:
1. Se o número da proposta estiver cadastrado em um bloco de proposta, então ela deve estar em um intervalo válido.
2. Não é possível reservar uma unidade em que a proposta informada esteja cancelada.
3. Não é possível reservar uma unidade em que a proposta esteja sendo utilizada por outra reserva.
Se estiver configurado para cobrar taxa:
1. O valor da taxa de reserva deverá ser maior que zero.
2. O valor da taxa de reserva não poderá ser maior que o valor máximo (“999999999999,99”) permitido pela base de dados.

Obs.:

Gravar uma reserva com taxa paga irá gerar um lançamento de entrada no controle financeiro.
Na tentativa de gravar uma reserva em que exista controle financeiro para a taxa definida, será excluído o lançamento no controle financeiro, pois esta estava definida como não paga.
Reserva para unidades do tipo 1 – Aluguel , 2 – Aluguel garantido e 5 – Aluguel Shopping, caso seja informado para cobrar taxa de reserva. O valor sugerido da taxa de reserva é o valor mínimo da unidade dividido por 30 dias * quantidade de dias reservado.
A data informada para inserção de controle financeiro será testada para fechamento do caixa contábil.
Segue o link para download do arquivo XSD (schemaReservaXSDeXML)
Exemplo segue o link: //200.178.248.104:86/portaluautestes/webservices/wsReserva.asmx?op=GravarReserva
Para gravar reservas do tipo venda:
- Para gravar (requisito mínimo) uma reserva de uma unidade do tipo venda é preciso que os seguintes campos estejam preenchidos na Tabela Reserva: Empresa_rsv, NumProd_rsv, NumPer_rsv, Num_rsv(se for nova, então é igual a zero), Vendedor_rsv, Login_rsv , Data_rsv, Periodo_rsv , Cliente_rsv, Fone_rsv, TempoIndet_rsv, Status_rsv, GeraTaxaReserva_rsv, ValReserva_rsv, ReservaPaga_rsv, DataCad_rsv.
- Para gravar uma reserva confirmada, além dos campos citados acima: DataConfir_rsv, UsrConfir_rsv, NumConf_rsv(igual a 0 se está inserindo), CodPesConfir_rsv.
Para gravar reservas do tipo aluguel(1, 2, 5):
- Para gravar (requisito mínimo) é preciso que os seguintes campos estejam preenchidos na Tabela Taxa além dos campos já mencionados anteriormente: Empresa_es, Banco_es, Conta_es, Num_es(igual a zero se estiver inserindo), EntSai_es (igual a 0), Obra_es, Data_es(escolhida pelo usuário), Usuario_es, Valor_es, Cap_es, Emissao_es, DataCad_es.

Área do Cliente

Central de Ajuda

Controle de reservas – Webservices

Introdução

Webservices

Excluir

Consultar

Gravar