Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Esses endpoints serão utilizados na nova tela de posição Gestão do beneficiárioBeneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular) 

...

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

...

Bloco de código
languagec#
themeMidnight
titleExemplo de retorno - Sucesso (Beneficiário sem transferência)
linenumberstrue
collapsetrue
{
  "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.

...

Bloco de código
languagec#
themeMidnight
titleExemplo de retorno - Sucesso (Beneficiário com transferência)
linenumberstrue
collapsetrue
{
  "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.

...

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

...