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).
Esses endpoints serão utilizados na nova tela de posiçã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
Retorna uma coleção com as lasses de carência do beneficiário e seus status.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/gracePeriodClass |
|
| 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 |
Não possui body!
| 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 |
{
"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
} |
{
"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
} |
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. |
{
"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.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/gracePeriodGroup |
|
| 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 |
Não possui body!
| 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 |
{
"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
} |
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. |
{
"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:
Code | message | detailedMessage | Status Code |
|---|---|---|---|
| E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} | 404 |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica. | Não se aplica. |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do beneficiário |
