Histórico da Página

...

02. EXEMPLO DE UTILIZAÇÃO

Dados do Contrato

Retorna os dados de contrato do beneficiário (Tabela BA1).

...

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

Beneficiários da Família

Retorna todos os beneficiários pertencente a família.

Endpoint

Url	Verbo
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/familyBeneficiaries	GET

Parâmetros

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

...

Request

Sem Body

...

Operação realizada com sucesso (200)

beneficiaries	Array	Beneficiários da Família
beneficiaries.card	String	Carteirinha do Beneficiário
beneficiaries.name	String	Nome do Beneficiário
beneficiaries.kinship	String	Grau de Parentesco do Beneficiário
beneficiaries.situation	String	Situação atual do Beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro

Bloco de código

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

{
  "beneficiaries": [
    {
      "card": "00011008000027010",
      "name": "HERNANDES ALVES DA SILVA",
      "kinship": "BENEFICIARIO TITULAR",
      "situation": "Ativo"
    },
    {
      "card": "00011008000027028",
      "name": "FABIANA SOPHIA MELO",
      "kinship": "CONJUGE/ COMPANHEIRO",
      "situation": "Ativo"
    }
  ]
}

...

Dados Inválidos (404)

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

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

...

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 DADOS DE CONTRATO

...

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão 7

Chave

02. EXEMPLO DE UTILIZAÇÃO

Dados do Contrato

Beneficiários da Família

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Dados Inválidos (404)

03. TELA DADOS DE CONTRATO