• Nenhum resultado encontrado

Especificação Técnica

N/A
N/A
Protected

Academic year: 2021

Share "Especificação Técnica"

Copied!
13
0
0

Texto

(1)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 1/13

Especificação Técnica

Projeto: Integração Fidelidade (Webservice)

Data: 07/05/2013

Versão: 3.0

IDENTIFICAÇÃO DO PROJETO

Número e Nome do Projeto: Integração Fidelidade (Webservice)

Descrição do Projeto: Especificação Técnica para troca de dados com o sistema de fidelização Marka. Documento: Especificação Técnica

(2)

Documento Especificação Técnica Data 07/05/2013 Versão 3.0 Páginas 2/13

Índice

OBJETIVO ... 3 INTRODUÇÃO... 3 FUNÇÕES... 4 ATUALIZACADASTRO... 4

CONSULTA CADASTRO E SALDO... 8

CADASTRARPRODUTO... 8

INSERIR VENDA... 9

ESTORNAVENDA: ... 10

ESTORNAVENDAPARCIAL:... 10

RESGATEPREMIO: ... 11

LISTATIPOOCORRENCIA:... 12

(3)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 3/13

Objetivo

Viabilizar a troca de informações entre a Software House (SH) e a Marka, permitindo o

cadastramento dos cliente e registro das vendas.

Introdução

A troca de informações será feita utillizando webservice no seguinte endereço:

http://ws2.cartaofidelidade.com/webservice/fidelidade.asmx

O webservice expõem as seguintes funções:

Essenciais:

Precisam ser obrigatoriamente implementadas

.

• InserirVenda

Essa função permite o envio dos dados da venda: cartao do cliente, data, hora, valor e lista de todos os produtos comprados.

A função retornará um endereço web (URL) que deverá ser aberto no navegador padrão da máquina do cliente (internet Explorer, Firefox, chrome, etc).

Essa função também permite o resgate de créditos. • EstornaVenda

Estorna a venda e restaura os créditos do cartão caso tenham sido utilizados • EstornaVendaParcial

Estorna parte da venda

Desejáveis:

O cadastro de clientes pode ser feito pelo site, mas fica mais ágil se a SH fizer a integração e enviar os cadastros de forma automática.

• ConsultaCadastroPorCPF

Permite buscar por CPF os dados cadastrais do cliente. • ConsultaCadastroPorCartao

Permite buscar pelo número do cartão fidelidade os dados cadastrais do cliente. • AtualizaCadastro

Essa função permite inserir um novo cadastro ou atualizar os dados cadastrais de um cliente

Opcionais:

As funções AtualizaPremio, ResgatePremio e EstornoResgatePremio só precisariam ser implementadas em projetos com pontos e prêmios. Projetos com acúmulo de créditos em dinheiro para uso como desconto em futuras compras não precisam integrar essas 3 funções. As demais funções são auxiliares.

• AtualizaPremio

Essa função permite cadastrar os prêmios do programa fidelidade • AtualizaCadastro

Essa função permite inserir um novo cadastro ou atualizar os dados cadastrais de um cliente. • AtualizaPremio

Essa função permite cadastrar os prêmios do programa fidelidade • CadastraFuncionario

Essa função permite cadastrar os funcionários (vendedor, atendente) utilizados nas funções AtualizaCadastro e InserirVenda • CadastrarProduto

Essa função permite inserir um novo produto ou atualizar um produto existente. • CancelarCartao

Essa função permite excluir um cartão do programa de fidelidade • ConfirmaAdesao

Permite confirmar que o cliente assinou a adesão ao programa • ConsultaCadastroPorCPF

(4)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 4/13

• ConsultaCadastroPorCartao

Permite buscar pelo número do cartão fidelidade os dados cadastrais do cliente. • ConsultaPreVenda

Essa função permite fazer uma pré-venda, simulando o envio de uma venda e obtendo os pontos que o cliente ganhará se a venda for efetivada • EstornoResgatePremio

Essa função permite estornar um resgate de prêmio • InserirCreditoExtra

Permite inserir um valor de créditos para um cartão. Não implementar sem autorização

• InserirOcorrencia

Essa função permite inserir uma ocorrência • ListaProfissoes

Essa função retorna a lista de profissões cadastradas no sistema • ListaTipoOcorrencia

Essa função retorna a lista de tipos de ocorrências cadastrados no sistema • ResgatePremio

Permite a baixa de pontos do saldo cliente e o resgate de prêmio • TrocadeCartao

Permite efetuar a troca do cartão do cliente por outro número •VerificaVenda

Permite confirmar se a venda foi inserida

Todas as funções exigem uma autenticação. Essa autenticação é feita através do

parâmetro de entrada “

LoginInfo

”.

Esse parâmetro possue os seguintes campos:

Campos Descrição Tipo

login identificação do operador cadastrado no sistema de fidelidade. (Informado pela Marka) Texto

Senha senha do operador. (Informado pela Marka) Texto

Idloja Número que identifica a loja na base do fidelidade. (Informado pela Marka) Texto Idmaquina Identificação da máquina que está fazendo o acesso ao webservice. Utilize o nome do

computador na loja (Caixa1, Caixa2, etc). Pode ser qualquer descrição alfanumérica e serve para gerarmos um relatório de log de qual computador originou a transação. (Informado pela SH)

Texto

Idcliente Identificação da base de dados do cliente no sistema de fidelidade. (Informado pela Marka) Texto

Os campos login, senha, idloja e idcliente são fornecidos pela Marka

Funções

Atualizacadastro

Função: AtualizaCadastro (

FichadeCadastro,

,

LoginInfo

) as string

Essa função permite:

1- Cadastrar um novo cliente

2- Atualizar os dados cadastrais de um cliente (Sugerimos alguns procedimentos para evitar a

sobreposição de dados antigos sobre novos. Leia com atenção o item “

importante

”)

A função AtualizaCadastro exige dois parâmetros de entrada:

FichadeCadastro

e

LoginInfo

.

A função retornará um texto (string) que poderá ser:

(5)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 5/13

1- Se conseguir cadastrar o novo cliente ou atualizar os dados de um cliente existente, essa

função retornará o texto “OK”.

2- Se houver algum erro ou falha na validação dos dados informados, a função retornará um

texto descrevendo o erro, por exemplo, “CPF Inválido”, “Número de cartão inválido”, “Email

inválido”, etc.

Em caso de erro, é importante exibir a mensagem na tela para que o atendente possa saber porque

motivo os dados não foram salvos e tomar a ação necessária para solicitar o dado faltante ou para

corrigir alguma informação.

Os dados cadastrais dos clientes são vitais para o sucesso do programa de fidelização. Informações

como endereço, email, telefone devem ser precisas para permitir que as ações de marketing cheguem

até o cliente.

Sugerimos que a SH faça uma pré-validação dos dados. Por exemplo, se o atendente digitou um

email ou um CPF inválido ou se algum campo obrigatório está faltando, seria recomendável que o

sistema no PDV já validasse essas informações, evitando fazer uma chamada desnecessária ao

webservice.

De qualquer forma, mesmo que essas validações não sejam feitas no PDV, o webservice irá fazer e

não vai permitir dados incompletos ou inválidos serem salvos no sistema do fidelidade.

Existem dois modelos de cadastramento, o modelo simplificado e o modelo completo.

O modelo completo só dever utilizado para quem tem uma base consistente de dados do cliente ou

tem condições de apresentar uma ficha completa em tela para o operador solicitar todos os dados do

cliente.

A SH deverá exibir uma tela de cadastro com pelo menos os seguintes campos:

1-

Cadastro de Pessoa Física: Nome, Número do cartão fidelidade, CPF, RG, Sexo, Data de

nascimento, Data de cadastro (cliente desde), Endereço Completo (Rua, Numero,

Complemento, Bairro, Cidade, Estado, CEP), Telefones (Residencial, Celular, Comercial),

Email, Profissão*, Estado Civil, Nome e CPF do atendente do caixa, Nome e CPF do

Fidelizador, Cartão do Titular e Grupo.

2-

Cadastro de Pessoa Jurídica: Razão Social, CNPJ, Número do cartão fidelidade,Nome do

Portador, CPF, RG, Sexo, Data de nascimento, Data de cadastro (cliente desde), Endereço

Completo (Rua, Numero, Complemento, Bairro, Cidade, Estado, CEP), Telefones

(Residencial, Celular, Comercial), Email, Profissão*, Estado Civil, Nome e CPF do

atendente do caixa, Nome e CPF do Fidelizador, Cartão do Titular e Grupo

*Uma lista de profissões pode ser baixada utilizando a função ListaProfissoes

Verifique na descrição da classe

FichadeCadastro

quais campos são obrigatórios e quais tags

correspondem a cada um dos campos da ficha de cadastro.

O cadastro simplificado é o recomendado em qualquer projeto. Esse modelo reduz o tempo de

cadastro na loja.

(6)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 6/13

A SH deverá exibir uma ficha de cadastro reduzida com apenas os seguintes campos: Nome,

Número do Cartão, Sexo, CPF, Data de Nascimento e Email.

Todos os campos são obrigatórios. O campo Nome pode ter só o primeiro nome do cliente, não

precisa ser o nome completo.

Independentemente do modelo adotado para o cadastramento, o cliente receberá um email com um

link para uma página web onde preencherá os demais dados cadastrais. Enquanto a ficha cadastral

estiver incompleta, o cliente não poderá resgatar seus créditos.

Segue abaixo a descrição de cada campo da classe

FichadeCadastro

. Em destaque estão os campos

obrigatórios.

Parâmetros de entrada:

FichadeCadastro

Campo Descrição Tipo

cartao Número do cartao fidelidade Número tipocliente Opções válidas: PF, PJ (Pessoa Física, Pessoa Jurídica) Texto nome Nome da empresa ou nome da pessoa física para o qual o cartão fidelidade está sendo

emitido.

Se o tipo de cliente for PJ, coloque nesse campo a razão social da empresa ou o nome fantasia.

Se o tipo de cliente for PF então nesse campo deve vir o nome do cliente.

Texto

cpf CPF do cliente. Assim como os demais campos referentes a informações pessoais (RG, Data de nascimento, etc), esse campo refere-se a pessoa física que recebeu o cartao, ou seja, ao cliente pessoa física ou no caso de pessoa jurídica, ao portador do cartão. Obrigatório no caso de PJ.

Texto

sexo Opções válidas: 1,0, M, F (Masculino, Feminino)

datanascimento Data de nascimento. Formato: AAAA-MM-DD Data

email Email Texto

dataalteracao Data da última atualização cadastral desse cliente. Envie em branco se for um cliente novo. Data cnpj CNPJ da empresa no caso de ser uma pessoa jurídica. Se for pessoa física deixe em branco.

Obrigatório se PJ.

Texto nomeportador Nome da pessoa portador do cartão caso o cartão fidelidade seja emitido para uma empresa

(pessoa jurídica). Se for uma pessoa física deixe esse campo em branco. É um campo obrigatório se tipocliente for PJ

Texto

rg RG do cliente Texto

grupo Código do grupo do cliente. Esse código será informado pela Marka. Exemplo, podem ser cadastrados o grupo de clientes Fidelidade e o grupo Vip. Pode-se definir o código de grupo F para o Fidelidade e V para o Vip. Passando esse parâmetro, o sistema de fidelização irá cadastrar o cliente no grupo correto.

Caso não seja enviado o grupo de clientes é preciso que o sistema de fidelidade esteja configurado por faixa de numeração de cartão. Dessa forma, o sistema associará

automaticamente o grupo em função do número do cartão. Verifique com o suporte da Marka qual será o modelo adotado, se precisará sempre enviar o grupo ou se ficará automático.

Texto

clientedesde Data de cadastro no sistema da loja. Formato: AAAA-MM-DD Data

endereco Endereço Texto

numero Numero referente ao endereço Texto complemento Complemento do endereço Texto

bairro Bairro Texto

cidade Cidade Texto

estado Estado (Sigla do estado – 2 caracteres) Texto cep Cep (Formato xxxxx-xxx) Texto telresidencial Telefone residencial com ddd. Formato (xxx) xxxx-xxxx Texto telcelular Telefone celular com ddd. Formato (xxx) xxxx-xxxx Texto telcomercial Telefone comercial com ddd. Formato (xxx) xxxx-xxxx Texto

(7)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 7/13

profissao Profissão. Pode-se trabalhar com dois modelos. A 1º opção é pegar com a Marka a lista de profissões válidas e enviar exatamente a mesma descrição. A 2º opção é trabalharmos com a tabela vazia no fidelidade e vamos automaticamente cadastrando em função das profissões que seu sistema nos enviar. Nesse último caso é importante manter algum controle de cadastro das profissões para evitar que digitem uma mesma profissão com abreviações ou erroneamente. O modelo ideal é mostrar para o operador do software uma lista pré-definida de profissões num combobox ou equivalente.

Para obter a lista de profissões na base do fidelidade chame a função ListaProfissoes do webservice.

Texto

estadocivil Estado civil. Opções válidas: Solteiro, Casado, Divorciado, Viúvo Texto cartaotitular Numero do cartão fidelidade do titular se for o cadastro de um cartão dependente, caso

contrário, deixar em branco.

Número

Importante: Antes de enviar para escrita os dados cadastrais de um cliente, é importante que primeiro seja feita

uma operação de consulta. A razão disso é que com diversas lojas em rede, o cliente pode ter seu cadastro atualizado em uma loja diferente e os dados na sua loja podem estar desatualizados. O cliente também pode atualizar seus dados cadastrais através do website. Em uma situação como essa se você enviar para escrita os dados desatualizados que estão na sua base, isso irá sobreescrever os dados mais atuais que estão

cadastrados no fidelidade.

Para evitar isso, recomendamos primeiro baixar os dados atuais chamando a função

ConsultaCadastroPorCartao ou ConsultaCadastroPorCPF. Ambas as funções retornam a ficha cadastral completa do cliente que poderá ser exibida em tela para atualização. Após as alterações, os dados poderão ser salvos na base local do PDV e enviados para o fidelidade chamando a função AtualizaCadastro.

Passos para cadastro de um novo cliente ou atualização de dados de um cliente:

1- Crei um caixa de texto para que o atendente digite o CPF ou número do cartão do cliente. 2- Chama a função ConsultaCadastroPorCpf e passe o CPF ou chame a função

ConsultaCadastroPorCartao e passe o número do cartão para procurar na base do fidelidade se esse cliente já está cadastrado ou não.

3- Se o cliente estiver no fidelidade,a função irá retornar os dados cadastrais e a data da última atualização do cadastro (campo <dataalteracao>). Exiba uma tela com as informações cadastrais (nome, telefone, endereço, etc) que a função retornou

4- Se o cliente não existir no fidelidade, exiba uma tela de cadastro em branco

5- Evite chamar a função AtualizaCadastro desnecessariamente. Procure validar os campos digitados como email, cpf, números de telefone, data de nascimento, etc.

6- Chame a função AtualizaCadastro para salvar o novo cadastro ou para atualizar um cadastro existente.

Resposta:

RetornoAtualizaCadastro

Campo Descrição Tipo

Msgerro Retorno o texto OK se gravou com sucesso ou retorna um texto descrevendo o motivo pelo qual não foi possível salvar os dados

(8)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 8/13

Consulta cadastro e saldo

Função: ConsultaCadastroPorCPF (

CPF

as string,

LoginInfo

) as

FichadeCadastro

Função: ConsultaCadastroPorCartao(

cartao

as string,

LoginInfo

) as

FichadeCadastro

Essa função permite baixar do programa fidelidade a ficha completa dos dados cadastrais do cliente

além do saldo atual de créditos ou pontos.

CadastrarProduto

Função: CadastrarProduto (

produto

,

LoginInfo

) as

RetornoCadastrarProduto

Essa função permite cadastrar um novo produto ou atualizar um produto existente.

É uma função opcional. Só é realmente necessária caso se deseje fazer filtros avançados em função

de atributos dos produtos.

Em uma integração simplificada, a função que registra as vendas, recebe como parâmetro o nome e

código de cada produto comprado e faz automaticamente o cadastramento desses produtos. Portanto,

mesmo que não seja feita uma carga inicial com todos os produtos vendidos no estabelecimento, o

sistema faz um preenchimento automático à medida que as vendas s

Parâmetros de entrada:

produto

:

parâmetro Descrição Tipo

Nome Descrição do produto Texto Codigo Código único que identifica o produto na loja. Sugestão utilizar o código de barras EAN. Texto Grupo Nome do grupo do produto. Texto Subgrupo Nome do subgrupo do produto Texto Marca Nome da marca do produto

Atributo1 ao 13 Campos para incluir atributos específicos do produto, por exemplo, se o produto for uma roupa, o atributo1 poderia ser a cor da roupa, o atributo2 o tamanho, o atributo3 o tipo do tecido, etc.

Texto

Resposta:

RetornoCadastrarProduto

parâmetro Descrição Tipo

Codigo Código único que identifica o produto na loja. Retorna o mesmo código enviado na classe Produto

Texto Msgerro Retorno o texto OK se gravou com sucesso ou retorna um texto descrevendo o motivo pelo

qual não foi possível salvar os dados

(9)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 9/13

Inserir Venda

Função: InserirVenda (

DadosdaVenda

,

LoginInfo

) as

RetornoVenda

Essa função permite o envio dos dados da venda: cartao do cliente, data, hora, valor e lista de todos

os produtos comprados. A função retornará opcionalmente um endereço web (URL) que deverá ser

aberto no navegador padrão da máquina do cliente (internet Explorer, Firefox, chrome, etc)

Essa função também permite o resgate de créditos.

Importante: A data e hora deve ser realmente a data e hora que a venda foi gravada no

banco de dados do sistema de automação da loja e não a data e hora que você está enviando a

venda para o webservice. Se a internet cair e a venda for enviada horas depois quando a internet

retornar, é importante que a data e hora seja a data real que a venda foi efetuada.

Parâmetros de entrada:

DadosdaVenda

Campo Descrição Tipo

id_vendapdv Chave primária de identificação da venda. Essa é uma chave interna do sistema da loja que nos será informada para eventual auditoria ou para localização do registro em caso de estorno.

Nunca deverá se repetir.

Texto datahora Data da venda. Formato AAAA-MM-DD HH:NN:SS Data cartao Numero do cartão fidelidade Numero valortotal Valor total da compra sem descontos. Valor com duas casas decimais. Usar a vírgula como

separador decimal

Decimal valor_resgate Valor a ser debitado do saldo de créditos do cliente. Esse campo só será informado quando o

cliente quiser utilizar seus créditos como parte do pagamento.

Valor com duas casas decimais. Usar a vírgula como separador decimal

Decimal

cupom Cupom fiscal Texto

formapagamento Forma de pagamento: dinheiro, cheque, etc Texto cartaoamigo Número do cartão do amigo que receberá pontos/creditos extras vinculados a essa compra. Os

pontos extras são especificados no campo abaixo “pontosextras”.

Se o campo “pontosextras” for deixado em branco e for informado um “cartaoamigo”, o sistema irá trasnferir os pontos/créditos ganhos na compra para o “cartão amigo”, deixando apenas o histórico da compra vinculado ao cartão informado no campo “cartao” Esse mecanismo funciona como uma transferência dos pontos/créditos para o “cartaoamigo”. (opcional)

Texto

pontosextras Quantidade de pontos extras que o cartão especificado no campo cartaoamigo receberá. Valor com duas casas decimais. Usar a vírgula como separador decimal (opcional)

Decimal Naopontuar Se enviar o valor “1”, indica que essa venda irá subir somente para efeito de histórico e o

cliente não receberá nenhum ponto/crédito. Qualquer outra valor ou se enviado em branco, o sistema entende que é pra pontuar.

Numero Lista de produtos

comprados (vendaitem)

Lista com todos os produtos comprados pelo cliente. Verificar abaixo a descrição dessa classe vendait em

vendaitem

Importante: Cada produto deverá ser informado uma única vez com a respectiva quantidade. Se o cliente comprou 2 itens do produto A, deve-se registrar o produto A com a quantidade “2” e não dois registros com a quantidade “1”. Muitas vezes os operadores de caixa lêem um código de barras de um produto repetidas vezes ao invés de colocar a quantidade do item. Na tela do sistema de automação você pode continuar

permitindo esse modo de operação mas na hora de enviar os dados para o webservice é preciso agrupar os produtos e totalizar as respectivas quantidades.

(10)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 10/13

parâmetro Descrição Tipo

id_item Chave primária de identificação da venda desse item. Essa é uma chave interna do sistema

da loja que nos será informada para eventual auditoria ou para localização do registro em

caso de estorno. Nunca deverá se repetir.

String produto Descrição do produto Texto codigoproduto Código único que indentifica o produto Texto quantidade Quantidade do produto sendo adquirida. Pode-se informar até 3 casas decimais para o caso,

por exemplo, de litros de combustível

Decimal valor Valor total desse item, ou seja, valor unitário desse produto X quantidade comprada. Não é

o valor unitário nem é o valor total de todos os produtos dess compra. É apenas o valor total a ser pago nesse item específico.

Valor com duas casas decimais. Usar a vírgula como separador decimal

Decimal

Resposta:

RetornoVenda

Campo Descrição Tipo

msgerro Mensagem de erro devolvida pelo servidor. Se não houver erro, esse campo virá com o texto “OK”

Texto nome Nome do cliente que foi pontuado. Texto saldo Saldo de pontos/créditos total do cliente. Decimal Saldoresgate Saldo disponível para resgate hoje Decimal comprovante Texto para ser impresso em um cupom não fiscal Texto comprovante_resgate Texto para ser impresso em um cupom não fiscal referente ao resgate de créditos do

cliente

Texto url Endereço web que a aplicação poderá abrir para exibição do saldo de pontos do

cliente, lista de prêmios e informações adicionais. Exemplo:http://www.cartaofidelidade.com/xxx

Texto

EstornaVenda:

Função: EstornaVenda (

id_vendapdv

As string,

LoginInfo

) as

RetornoVenda

Essa função permite o estorno completo de uma venda. Deve-se informar o id_vendapdv, ou seja, a

chave primária de indentificação da venda que foi enviada na função InserirVenda.

Essa função retorna a mesma estrutura de retorno da função InserirVenda:

RetornoVenda

EstornaVendaParcial:

Função: EstornaVenda (

DadosEstornoParcial

,

LoginInfo

) as

RetornoEstornoParcial

Essa função permite estorno parcial, ou seja, de alguns itens de uma venda.

Parâmetros de entrada:

DadosEstornoParcial

Campo Descrição Tipo

id_vendapdv Chave primária de identificação da venda. Texto Cartao Número do cartão do cliente (opcional) Texto

(11)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 11/13

EstornoItem

Campo Descrição Tipo

Codigoproduto Codigo que identifica o produto sendo devolvido Texto Quantidade Quantidade do produto que está sendo devolvida Numero

Resposta:

RetornoEstornoParcial

Campo Descrição Tipo

msgerro Mensagem de erro devolvida pelo servidor. Se não houver erro, esse campo virá com o texto “OK”

Texto nome Nome do cliente que foi pontuado Texto cartao Cartao fidelidade do cliente Texto saldo Saldo de pontos/créditos total do cliente. Decimal comprovante Texto para ser impresso em um cupom não fiscal Texto url Endereço web que a aplicação poderá abrir para exibição do saldo de pontos do

cliente, lista de prêmios e informações adicionais. Exemplo:http://www.cartaofidelidade.com/xxx

Texto

ResgatePremio:

Função: ResgatePremio (

ResgatePremios

,

LoginInfo

) as

RetornoResgatePremios

Esta função permite fazer a troca de pontos por um ou mais prêmios, desde que o cliente tenha

saldo suficiente

Parâmetros de entrada:

ResgatePremios

Campo Descrição Tipo

Cartao Número do cartão do cliente (opcional) Texto

Lista de prêmios Lista de prêmios que serão resgatados pelo cliente ResgatePremiosItem ResgatePremiosItem

Campo Descrição Tipo

codpremio Codigo que identifica o prêmio que o cliente quer retirar Texto quantidade Quantidade do prêmio a ser retirado Numero

Resposta:

RetornoResgatePremios

Campo Descrição Tipo

msgerro Mensagem de erro devolvida pelo servidor. Se não houver erro, esse campo virá com o texto “OK”

Texto nome Nome do cliente que foi pontuado. Texto cartao Cartao fidelidade do cliente Texto

(12)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 12/13

saldo Saldo de pontos/créditos total do cliente. Decimal Lista de prêmios

resgatados

Lista de prêmios que o cliente resgatou com o número da autorização RetornoResgatePremiosItem RetornoResgatePremiosItem

Campo Descrição Tipo

Autorizacao Número de autorização que comprova o resgate do prêmio. Esse número deve ser salvo. Em caso de estorno do resgate do prêmio, esse número precisará ser informado

Numero codpremio Codigo que identifica o prêmio que o cliente retirou Texto Quantidade Quantidade do prêmio retirada Numero Pontos Pontos necessários para retirada de 1 (um) prêmio desse tipo. Numero

ListaTipoOcorrencia:

Função: ListaTipoOcorrencia

(LoginInfo) As RetornoListaTipoOcorrencia

Essa função apenas retorna uma lista dos tipos de ocorrências cadastradas no sistema. È uma função

auxiliar, que permite que se monte uma caixa de seleção para o atendente selecionar o tipo da

ocorrência. Deve-se salvar o “ID” do tipo da ocorrência para enviar na função InserirOcorrência.

Resposta:

RetornoListaTipoOcorrencia

Msgerro Retorno OK ou o erro ocorrido ao tentar trazer a lista de tipos de ocorências texto Lista de tipos de ocorrencia

(TipoOcorrencia)

Lista com todos os tipos de ocorrência. Ver descrição abaixo dos itens dessa classe.

TipoOcorrencia TipoOcorrencia

id Codigo que identifica o tipo da ocorrência no banco de dados. Salve esse código para enviar na função InserirOcorrência

Numero descrição Descrição do tipo da ocorrência texto

InserirOcorrencia:

Função: InserirOcorrencia

(Ocorrência, LoginInfo) As RetornoInserirOcorrencia

Essa permite inserir uma ocorrência no sistema para ser resolvido pelo pessoal responsável.

Entrada:

Ocorrência

id_tipoocorrencia “ID” (código) que identifica o tipo da ocorrência. Para consultar os tipos de ocorrências e respectivos códigos utilize a função ListaTipoOcorrencia

Numero

cartao Opcional. Número do cartão do cliente cujo problema precisa ser resolvido. Caso a ocorrência não envolva um cliente esse campo não precisa ser enviado

Numero

texto Descrição do problema

Respota:

RetornoInserirOcorrencia

Msgerro Retorno OK ou o erro ocorrido ao tentar inserir a ocorrência no sistema texto

(13)

Documento Especificação Técnica Data 07/05/2013

Versão 3.0 Páginas 13/13

Essa documentação está sujeita a erros de digitação. Pedimos a gentileza de nos informar sobre erros

encontrados nesse documento.

Referências

Documentos relacionados

Número do Celular Celular do cliente pessoa física Int 11 Não Telefone do Trabalho Telefone do cliente pessoa física Int 11 Não Data de Nascimento Data Nascimento do

Os dados pessoais e dados pessoais sensíveis; nome completo, n° CPF, data de nascimento, sexo, estado civil, endereço completo, e-mail, telefone res., telefone

Para isso, trataremos dos seguintes dados: (i) Dados Cadastrais: Nome Completo, RG, CPF, CNH, Data de Nascimento, Idade, Sexo, Endereço Residencial e Eletrônico,

cadastro@centraldosbeneficios.com.br as seguintes informações sobre todos os empregados: NOME COMPLETO, CPF, DATA DE NASCIMENTO, TELEFONE CELULAR DO EMPREGADO, EMAIL DO

Dados necessários para realização da inscrição: Emprego pretendido, Nome Completo, RG, CPF, Sexo, Estado Civil, Data de Nascimento, Escolaridade, Endereço completo, CEP,

- do candidato: 1) Certidão de Nascimento, 2) RG (Carteira de Identidade); 3) CPF (Cadastro de Pessoa Física); 4) Declaração de Conclusão do Ensino Fundamental

a) Formação de cadastro para participação na promoção: Nome completo, CPF, data de nascimento, endereço completo, telefone e e-mail. b) Reforço de Mídia

Os dados pessoais e dados pessoais sensíveis; nome completo, n° CPF, data de nascimento, sexo, estado civil, endereço completo, e-mail, telefone residencial, telefone