Árvore de páginas

Versões comparadas

Chave

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

...

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

Endpoint

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

Image Modified

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

...

code

Código identificador do erro. (Tabela de ErroErros)

message

Literal no idioma da requisição descrevendo o erro para o usuário.

detailedMessage

Mensagem técnica e mais detalhada do erro.

...

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

Endpoint

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

Image Modified

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

...

code

Código identificador do erro. (Tabela de ErroErros)

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

Tabela de Código de

...

Erros

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

...