API beneficiaryPosition - Endpoint: Carências do Beneficiário

CONTEÚDO

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 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

Parâmetros

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

Request

Não possui body!

Operação realizada com sucesso (200)

beneficiaryTransfer		Indica se o beneficiário teve transferência de plano.
items		Classes de carência do beneficiário
items.classCode		Código da classe de carência Campo: BDL_CODIGO
items.description		Descrição da classe de carência Campo: BDL_DESCRI
items.finalDatePrevious		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		Status da carência da rede migrada (Plano anterior) Atributo retornado somente quando o beneficiário tiver transferência (beneficiaryTransfer igual true)
items.finalDateCurrent		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		Status da carência da nova rede (Plano atual) Atributo retornado somente quando o beneficiário tiver transferência (beneficiaryTransfer igual true)
items.finalDate		Data final da carência Atributo retornado somente quando o beneficiário não tiver transferência (beneficiaryTransfer igual false)
items.status		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		Indica se ainda existem registros a serem retornados
remainingRecords		Quantidade de registros ainda existem para retorno

Exemplo de retorno - Sucesso (Beneficiário com transferência)

{
  "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
}

Exemplo de retorno - Sucesso (Beneficiário sem transferência)

{
  "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		Código identificador do erro. (Tabela de Erros)
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		Mensagem técnica e mais detalhada do erro.

Exemplo de retorno - Falha

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

Grupo de Carência

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

Endpoint

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

Parâmetros

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

Request

Não possui body!

Operação realizada com sucesso (200)

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

Exemplo de retorno - Sucesso

{
  "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		Código identificador do erro. (Tabela de Erros)
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		Mensagem técnica e mais detalhada do erro.

Exemplo de retorno - Falha

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

Tabela de Código de Erros

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

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

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica.	Não se aplica.

04. TELA CARÊNCIAS DO BENEFICIÁRIO

Principais Campos e Parâmetros

Campo	Descrição
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO	Carteirinha do beneficiário

05. TABELAS UTILIZADAS

BA1 - Beneficiários

Árvore de páginas

API beneficiaryPosition - Endpoint: Carências do Beneficiário

CONTEÚDO

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

Grupo de Carência

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Tabela de Código de Erros

03. TELA CARÊNCIAS DO BENEFICIÁRIO

04. TELA CARÊNCIAS DO BENEFICIÁRIO

05. TABELAS UTILIZADAS