POST api/Integracao/ConsultaConsumidor

Informações para Requisição

URI Parameters

None.

Body Parameters

ConsumidorIntegracao
NomeDescriçãoTipoDetalhe
cpf

CPF do consumidor a ser consultado

 string

None.
cartao

Cartão vinculado ao consumidor

 string

None.
token_externo

ID Único do consumidor no seu sistema, pode ser populado com o UUID, ID de autenticação do Facebook, LinkedIn etc.

 string

None.
telefone

Telefone do consumidor a ser consultado

 string

None.
categoria

Retornar os dados de categoria do consumidor

 boolean

None.
endereco

Retornar os dados de categoria do consumidor

 boolean

None.
tag

Retornar os dados de tags do consumidor

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "cpf": "sample string 1",
  "cartao": "sample string 2",
  "token_externo": "sample string 3",
  "telefone": "sample string 4",
  "categoria": true,
  "endereco": true,
  "tag": true
}

application/xml, text/xml

Sample: 
<ConsumidorIntegracao xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fidelimax.WebApi.Models">
  <CPF>sample string 1</CPF>
  <Cartao>sample string 2</Cartao>
  <CategoriaConsumidores>true</CategoriaConsumidores>
  <Endereco>true</Endereco>
  <RetornarTags>true</RetornarTags>
  <Telefone>sample string 4</Telefone>
  <TokenExterno>sample string 3</TokenExterno>
</ConsumidorIntegracao>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ConsumidorIntegracao'.

Informações de Resposta

Resource Description

ConsultaConsumidor
NomeDescriçãoTipoDetalhe
consumidor_existente

Identificador se o cliente existe na base.

 boolean

None.
nome

Nome do consumidor

 string

None.
saldo

Saldo de pontos do consumidor.

 integer

None.
pontos_expirar

Pontos a expirar no fim do mês

 integer

None.
cashback

decimal number

None.
categoria

string

None.
configuracao_programa

RetornoConfiguracaoPrograma

None.
congelado

boolean

None.
produtos

Lista de produtos disponiveis

 Collection of RetornoProdutoConsumidorIntegracao

None.
CodigoResposta

CodigoResposta

None.
MensagemErro

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "consumidor_existente": true,
  "nome": "sample string 2",
  "saldo": 3,
  "pontos_expirar": 4,
  "cashback": 5.0,
  "categoria": "sample string 6",
  "configuracao_programa": {
    "valor_minimo_resgate_cashback": 1,
    "valor_maximo_resgate_cashback": 1
  },
  "congelado": true,
  "produtos": null,
  "CodigoResposta": 100,
  "MensagemErro": "sample string 8"
}

application/xml, text/xml

Sample: 
<ConsultaConsumidor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fidelimax.WebApi.Models">
  <CodigoResposta xmlns="http://schemas.datacontract.org/2004/07/FideliMax.WebApi.Objects">Ok</CodigoResposta>
  <MensagemErro xmlns="http://schemas.datacontract.org/2004/07/FideliMax.WebApi.Objects">sample string 8</MensagemErro>
  <CadastroCongelado>true</CadastroCongelado>
  <Cashback>5</Cashback>
  <CategoriaAtual>sample string 6</CategoriaAtual>
  <ConsumidorExistente>true</ConsumidorExistente>
  <NomeConsumidor>sample string 2</NomeConsumidor>
  <PontosExpirarMes>4</PontosExpirarMes>
  <ProdutosDisponiveis i:nil="true" />
  <RetornoConfiguracaoPrograma xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fidelimax.WebApi.Models.Retornos.RegrasPrograma">
    <d2p1:ValorMaximoResgateCashback>1</d2p1:ValorMaximoResgateCashback>
    <d2p1:ValorMinimoResgateCashback>1</d2p1:ValorMinimoResgateCashback>
  </RetornoConfiguracaoPrograma>
  <SaldoPontos>3</SaldoPontos>
</ConsultaConsumidor>