Árvore de páginas

Versões comparadas

Chave

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


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Grupos de Coberturas
    2. Tabela de Códigos de Erros
  3. Tela Coberturas do Beneficiário
    1. Outras Ações / Ações relacionadas
  4. Tela Coberturas do Beneficiário
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

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

  • /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/coverageGroup

Essee endpoint será utilizado 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

02. EXEMPLO DE UTILIZAÇÃO

Grupos de Coberturas

Retorna uma coleção com os grupos de coberturas do beneficiário.

Endpoint

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

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 cobertura do beneficiário
items.groupCode

Código do grupo de cobertura

Campo:  BG7_CODGRU

items.coverageGroup

Descrição do grupo de cobertura

Campo:  BG7_DESCRI

items.level

Nível

sendo:  Usuario, Familia, Empresa e Produto

hasNext

Indica se ainda existem registros a serem retornados
remainingRecords

Quantidade de registros ainda existem para retorno
Bloco de código
languagec#
themeMidnight
titleExemplo de retorno - Sucesso
linenumberstrue
collapsetrue
{
  "items": [
    {
      "groupCode": "004",
      "coverageGroup": "AMBULATORIAL",
      "level": "Produto"
    },
    {
      "groupCode": "007",
      "coverageGroup": "Z",
      "level": "Produto"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0
}

Dados Inválidos (404) 

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 - Falha
linenumberstrue
collapsetrue
{
  "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 (404):

Code

message

detailedMessage

E001

Beneficiário não encontrado.

Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}

03. TELA COBERTURAS DO BENEFICIÁRIO

Outras Ações / Ações relacionadas

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

04. TELA COBERTURAS DO BENEFICIÁRIO

Principais Campos e Parâmetros

CampoDescrição
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITOCarteirinha do beneficiário

05. TABELAS UTILIZADAS

  • BA1 - Beneficiários