Histórico da Página
...
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "fields": { "ba1_cpfusr": "23576483098", "ba1_drgusr": "", "ba1_nomusr": "HERNANDES ALVES DA SILVA", "ba1_datnas": "2001-06-15", "ba1_sexo": "1", "ba1_estciv": "Solteiro(a)", "ba1_mae": "TESTE", "ba1_endere": "", "ba1_comend": "", "ba1_bairro": "", "ba1_munici": "", "ba1_estado": "", "ba1_pai": "", "ba1_datblo": "", "ba1_motblo": "", "situation": "Ativo", "card": "00011008000027010" }, "struct": [ { "field": "BA1_BAIRRO", "type": "C", "title": "Bairro", "description": "Bairro do Usuario", "picture": "@!", "size": 20, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_COMEND", "type": "C", "title": "Complemento", "description": "Complemento do Endereco", "picture": "@!", "size": 20, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_ENDERE", "type": "C", "title": "Endereço", "description": "Endereco do Usuario", "picture": "@!", "size": 40, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_PAI", "type": "C", "title": "Nome Pai", "description": "Nome do Pai", "picture": "@!", "size": 30, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_ESTADO", "type": "C", "title": "Estado", "description": "Estado do Usuario", "picture": "@!", "size": 2, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_MUNICI", "type": "C", "title": "Município", "description": "Municipio do Usuario", "picture": "@!", "size": 30, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_MAE", "type": "C", "title": "Mãe", "description": "Nome da Mae", "picture": "@!", "size": 120, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_NOMUSR", "type": "C", "title": "Nome Usuário", "description": "Nome do Usuario", "picture": "@!", "size": 70, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_DRGUSR", "type": "C", "title": "RG", "description": "RG do Usuario", "picture": "@!", "size": 11, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_CPFUSR", "type": "C", "title": "CPF", "description": "CPF do Usuário", "picture": "@R 999.999.999-99", "size": 11, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_ESTCIV", "type": "C", "title": "Estado Civil", "description": "Estado Civil", "picture": "@!", "size": 1, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_SEXO", "type": "C", "title": "Sexo", "description": "Sexo", "picture": "@!", "size": 1, "decimals": 0, "cbox": [ { "value": "1", "description": "Masculino" }, { "value": "2", "description": "Feminino" }, { "value": "x", "description": "Anonimizado" } ], "folder": "1" }, { "field": "BA1_DATNAS", "type": "D", "title": "Dt. Nascto.", "description": "Data de Nascimento", "picture": "@D", "size": 8, "decimals": 0, "cbox": [], "folder": "1" }, { "field": "BA1_MOTBLO", "type": "C", "title": "Motivo Bloq.", "description": "Motivo do Bloqueio", "picture": "@!", "size": 3, "decimals": 0, "cbox": [], "folder": "6" }, { "field": "BA1_DATBLO", "type": "D", "title": "Data Bloq.", "description": "Data do Bloqueio", "picture": "@D", "size": 8, "decimals": 0, "cbox": [], "folder": "6" } ], "folders": [ { "id": "1", "title": "Dados Pessoais" }, { "id": "3", "title": "Relativos ao Plano" }, { "id": "4", "title": "Cobranca" }, { "id": "5", "title": "Ans" }, { "id": "6", "title": "Outros" }, { "id": "7", "title": "Regras de parcelamento" } ] } |
...
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "code": "E001", "message": "Beneficiário não encontrado.", "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010" } |
03. TELA DADOS DE CONTRATO
Outras Ações / Ações relacionadas
...
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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 Erro
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
Outras Ações / Ações relacionadas
Ação | Descrição |
---|---|
Não se aplica. | Não se aplica. |
04. TELA DADOS DE CONTRATO
Principais Campos e Parâmetros
Campo | Descrição |
---|---|
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do Beneficiário |
04. TELA DADOS DE CONTRATO
Principais Campos e Parâmetros
Campo | Descrição
---|
05. TABELAS UTILIZADAS
- BA1 - Beneficiários
- BRP - Graus de Parentesco
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas