Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

Estoque de Clientes com Consentimentos Ativos:

Nesta tabela, é necessário informar a quantidade total de consentimentos de clientes pessoa física e clientes pessoa jurídica.

Para preencher os campos de "Clientes únicos PF total" e "Clientes únicos PJ", é necessário realizar a seguinte chamada no Postman:

{{api_url}}/api/management/reports/v1/consents/receptions/identification?initialDate=&finalDate=&kind=DATA&status=AUTHORISED

Para filtrar por período, é necessário adicionar as datas da seguinte forma nos campos do "params":

initialDate: 2022-07-16T00:00:00-03:00 

finalDate: 2022-07-22T23:59:59-03:00

*manter o horário conforme o exemplo.

Conforme exemplo abaixo:

As colunas da tabela devem ser preenchidas da seguinte forma:

"Clientes únicos PF total": utilizar o campo "distinctCpf" do retorno para preenchimento.

"Clientes únicos PJ": utilizar o campo "distinctCnpj" do retorno para preenchimento.

___________________________________________________________________________________________________________________

Estoque de Consentimentos Ativos:

Agora para preencher a tabela, é necessário realizar a seguinte chamada no Postman: 

{{api_url}}/api/management/reports/v1/consents/receptions?initialDate=&finalDate=&organizationId&kind=DATA

Filtrando pelo período desejado. Dessa forma, será possível localizar o organizationId das instituições que possui consentimentos ativos durante o período.

Para filtrar por período, é necessário adicionar as datas da seguinte forma nos campos do "params":

initialDate: 2022-07-16T00:00:00-03:00 

finalDate: 2022-07-22T23:59:59-03:00

*manter o horário conforme o exemplo.

Na sequência, realize outra chamada no Postman: 

{{api_url}}/api/management/reports/v1/consents/receptions/status?initialDate=&finalDate=&organizationId=&kind=DATA

E filtre por período e organizationId indicado  na resposta da primeira chamada.

Para filtrar por período, é necessário adicionar as datas da seguinte forma nos campos do "params":

initialDate: 2022-07-16T00:00:00-03:00 

finalDate: 2022-07-22T23:59:59-03:00

*manter o horário conforme o exemplo.

** algumas instituições podem ter mais de um ID, nesse caso é necessário realizar a somatória dos consentimentos das instituições do mesmo grupo.

Segue exemplo abaixo:

No retorno desta API, considerar o objeto "data" para adicionar na tabela. O campo "AUTHORISED" será utilizado para a coluna "Estoque de Consentimentos Ativos".

  • No labels