Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Classe de Carência
2. Grupo de Carência
3. Tabela de Códigos de Erros
Tela Carências do Beneficiário
1. Outras Ações / Ações relacionadas
Tela Carências do Beneficiário
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização dos endpoints de carências do beneficiário, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).

/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/gracePeriodClass
/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/gracePeriodGroup

Esses endpoints serão utilizados na nova tela de

...

Gestão do

...

Beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)

Clique aqui para detalhes sobre como habilitar o serviço de APIs

02. EXEMPLO DE UTILIZAÇÃO

Classe de Carência

Retorna os status das classes uma coleção com as lasses de carência do beneficiário e seus status.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/gracePeriodClass

Image Modified

Parâmetros

SubscriberId (path)	Image Modified	Número da carteirinha do beneficiário	*required
Authorization (header)	Image Modified	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Modified	'application/json' é o formato do conteúdo	*required

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

beneficiaryTransfer	Image Modified	Indica se o beneficiário teve transferência de plano.
items	Image Modified	Classes de carência do beneficiário
items.classCode	Image Modified	Código da classe de carência Campo: BDL_CODIGO
items.description	Image Modified	Descrição da classe de carência Campo: BDL_DESCRI
items.finalDatePrevious	Image Modified	Data final da carência da rede migrada (Plano anterior) Atributo retornado somente quando o beneficiário tiver transferência (beneficiaryTransfer igual true)
items.statusPrevious	Image Modified	Status da carência da rede migrada (Plano anterior) Atributo retornado somente quando o beneficiário tiver transferência (beneficiaryTransfer igual true)
items.finalDateCurrent	Image Modified	Data final da carência da nova rede (Plano atual) Atributo retornado somente quando o beneficiário tiver transferência (beneficiaryTransfer igual true)
items.statusCurrent	Image Modified	Status da carência da nova rede (Plano atual) Atributo retornado somente quando o beneficiário tiver transferência (beneficiaryTransfer igual true)
items.finalDate	Image Modified	Data final da carência Atributo retornado somente quando o beneficiário não tiver transferência (beneficiaryTransfer igual false)
items.status	Image Modified	Status da Carência, sendo: Carência Cumprida e Em Carência Atributo retornado somente quando o beneficiário não tiver transferência (beneficiaryTransfer igual false)
hasNext	Image Modified	Indica se ainda existem registros a serem retornados
remainingRecords	Image Modified	Quantidade de registros ainda existem para retorno

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (Beneficiário com transferência)
linenumbers	true
collapse	true

{
  "beneficiaryTransfer": true,
  "items": [
    {
      "classCode": "001",
      "description": "AUXILIO FUNERAL",
      "finalDatePrevious": "2022-01-01",
      "statusPrevious": "Carencia Cumprida",
      "finalDateCurrent": "2022-01-01",
      "statusCurrent": "Carencia Cumprida"
    },
    {
      "classCode": "002",
      "description": "CONSULTA",
      "finalDatePrevious": "2022-01-13",
      "statusPrevious": "Carencia Cumprida",
      "finalDateCurrent": "2022-01-13",
      "statusCurrent": "Carencia Cumprida"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0
}

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (Beneficiário sem transferência)
linenumbers	true
collapse	true

{
  "beneficiaryTransfer": false,
  "items": [
    {
      "classCode": "001",
      "description": "AUXILIO FUNERAL",
      "finalDate": "2022-01-01",
      "status": "Carencia Cumprida"
    },
    {
      "classCode": "002",
      "description": "CONSULTA",
      "finalDate": "2022-01-13",
      "status": "Carencia Cumprida"
    },
    {
      "classCode": "004",
      "description": "DOENCA PRE-EXISTENTE",
      "finalDate": "2022-01-01",
      "status": "Carencia Cumprida"
    },
    {
      "classCode": "008",
      "description": "PERIODONTIA",
      "finalDate": "2022-01-22",
      "status": "Carencia Cumprida"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0
}

...

Mensagens de Erros

code	Image Modified	Código identificador do erro. (Tabela de Erros)
message	Image Modified	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Modified	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
}

...

Retorna os status dos grupos de carência do beneficiário.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/gracePeriodGroup

Image Modified

Parâmetros

SubscriberId (path)	Image Modified	Número da carteirinha do beneficiário	*required
Authorization (header)	Image Modified	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Modified	'application/json' é o formato do conteúdo	*required

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items	Image Modified	Grupos de carências do beneficiário
items.groupCode	Image Modified	Código do grupo de carência Campo: BAY_CODGRU
items.description	Image Modified	Descrição do grupo de carência Campo: BAT_DESCRI
items.date	Image Modified	Data da carência
items.status	Image Modified	Status da carência
hasNext	Image Modified	Indica se ainda existem registros a serem retornados
remainingRecords	Image Modified	Quantidade de registros ainda existem para retorno

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (Beneficiário com transferência)
linenumbers	true
collapse	true

{
  "items": [
    {
      "groupCode": "001",
      "description": "CONSULTAS",
      "date": "2022-11-25",
      "status": "Carencia Cumprida"
    },
    {
      "groupCode": "002",
      "description": "EXAMES",
      "date": "2022-11-25",
      "status": "Carencia Cumprida"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0
}

...

Mensagens de Erros

code	Image Modified	Código identificador do erro. (Tabela de Erros)
message	Image Modified	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Modified	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
}

...

Código de erros informado no Json de retorno com falha (404):

Code	message	detailedMessage	Status Code
E001	Beneficiário não encontrado.	Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}	404

03. TELA CARÊNCIAS DO BENEFICIÁRIO

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Classe de Carência

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

03. TELA CARÊNCIAS DO BENEFICIÁRIO