Histórico da Página
...
Esses endpoints são utilizados na nova tela de posição Gestão do beneficiárioBeneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
...
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": "", "ba1_nomsoc": "MARIA HERNANDES", "ba3_codemp": "1008", "ba3_desemp": "EMPRESA VINICIUS TEIXEIRA", "ba3_conemp": "000000000001", "ba3_vercon": "001", "ba3_subcon": "000000003", "ba3_versub": "001", "ba3_dessub": "SUBCONTRATO USO GERAL", "situation": "Ativo", "card": "00011008000027010" }, "struct": [ { "field": "BA3_CODEMP", "type": "C", "title": "Grupo/Empr.", "description": "Grupo/Empresa", "picture": "@!", "size": 4, "decimals": 0, "cbox": [], "folder": "1", "order": "04" }, { "field": "BA3_DESEMP", "type": "C", "title": "Desc. Grupo", "description": "Empresa", "picture": "@!", "size": 25, "decimals": 0, "cbox": [], "folder": "1", "order": "05" }, { "field": "BA3_CONEMP", "type": "C", "title": "Contr. Empr.", "description": "Contrato Empresa", "picture": "@!", "size": 12, "decimals": 0, "cbox": [], "folder": "1", "order": "06" }, { "field": "BA3_VERCON", "type": "C", "title": "Versão Cont.", "description": "Versao Contrato", "picture": "@!", "size": 3, "decimals": 0, "cbox": [], "folder": "1", "order": "07" }, { "field": "BA3_SUBCON", "type": "C", "title": "Sub-Contrato", "description": "Sub-Contrato", "picture": "@!", "size": 9, "decimals": 0, "cbox": [], "folder": "1", "order": "08" }, { "field": "BA3_VERSUB", "type": "C", "title": "Versão SubCo", "description": "Versao Sub-Contrato", "picture": "@!", "size": 3, "decimals": 0, "cbox": [], "folder": "1", "order": "09" }, { "field": "BA3_DESSUB", "type": "C", "title": "Desc. Sub.", "description": "Descricao Sub-Contrato", "picture": "@!", "size": 40, "decimals": 0, "cbox": [], "folder": "1", "order": "10" }, { "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", "order": "11" }, { "field": "BA1_DRGUSR", "type": "C", "title": "RG", "description": "RG do Usuario", "picture": "@!", "size": 11, "decimals": 0, "cbox": [], "folder": "1", "order": "13" }, { "field": "BA1_NOMUSR", "type": "C", "title": "Nome Usuário", "description": "Nome do Usuario", "picture": "@!", "size": 70, "decimals": 0, "cbox": [], "folder": "1", "order": "16" }, { "field": "BA1_DATNAS", "type": "D", "title": "Dt. Nascto.", "description": "Data de Nascimento", "picture": "@D", "size": 8, "decimals": 0, "cbox": [], "folder": "1", "order": "18" }, { "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", "order": "20" }, { "field": "BA1_ESTCIV", "type": "C", "title": "Estado Civil", "description": "Estado Civil", "picture": "@!", "size": 1, "decimals": 0, "cbox": [], "folder": "1", "order": "23" }, { "field": "BA1_MAE", "type": "C", "title": "Mãe", "description": "Nome da Mae", "picture": "@!", "size": 120, "decimals": 0, "cbox": [], "folder": "1", "order": "30" }, { "field": "BA1_ENDERE", "type": "C", "title": "Endereço", "description": "Endereco do Usuario", "picture": "@!", "size": 40, "decimals": 0, "cbox": [], "folder": "1", "order": "41" }, { "field": "BA1_COMEND", "type": "C", "title": "Complemento", "description": "Complemento do Endereco", "picture": "@!", "size": 20, "decimals": 0, "cbox": [], "folder": "1", "order": "43" }, { "field": "BA1_BAIRRO", "type": "C", "title": "Bairro", "description": "Bairro do Usuario", "picture": "@!", "size": 20, "decimals": 0, "cbox": [], "folder": "1", "order": "44" }, { "field": "BA1_MUNICI", "type": "C", "title": "Município", "description": "Municipio do Usuario", "picture": "@!", "size": 30, "decimals": 0, "cbox": [], "folder": "1", "order": "46" }, { "field": "BA1_ESTADO", "type": "C", "title": "Estado", "description": "Estado do Usuario", "picture": "@!", "size": 2, "decimals": 0, "cbox": [], "folder": "1", "order": "47" }, { "field": "BA1_PAI", "type": "C", "title": "Nome Pai", "description": "Nome do Pai", "picture": "@!", "size": 30, "decimals": 0, "cbox": [], "folder": "1", "order": "53" }, { "field": "BA1_NOMSOC", "type": "C", "title": "Nome Social", "description": "Nome Social", "picture": "@!", "size": 50, "decimals": 0, "cbox": [], "folder": "1", "order": "BZ" }, { "field": "BA1_DATBLO", "type": "D", "title": "Data Bloq.", "description": "Data do Bloqueio", "picture": "@D", "size": 8, "decimals": 0, "cbox": [], "folder": "6", "order": "68" }, { "field": "BA1_MOTBLO", "type": "C", "title": "Motivo Bloq.", "description": "Motivo do Bloqueio", "picture": "@!", "size": 3, "decimals": 0, "cbox": [], "folder": "6", "order": "69" } ], "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" } ] } |
...
...
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. |
...
beneficiaries | Beneficiários da Família | |
beneficiaries.card | Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO | |
beneficiaries.name | Nome do Beneficiário Campo: BA1_NOMUSR | |
beneficiaries.socialName | Nome social do Beneficiário Campo: BA1_NOMSOC | |
beneficiaries.kinship | Grau de Parentesco do Beneficiário Campo: BRP_DESCRI (Relacionamento pelo BA1_GRAUPA) | |
beneficiaries.situation | Situação atual do Beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro Campo: BA1_DATBLO |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "beneficiaries": [ { "card": "00011008000027010", "name": "HERNANDES ALVES DA SILVA", "socialName": "MARIA HERNANDES", "kinship": "BENEFICIARIO TITULAR", "situation": "Ativo" }, { "card": "00011008000027028", "name": "FABIANA SOPHIA MELO", "socialName": "", "kinship": "CONJUGE/ COMPANHEIRO", "situation": "Ativo" } ] } |
...
...
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 DADOS DE CONTRATO
...
- BA1 - Beneficiários
- BRP - Graus de Parentesco
- BA3 - Famílias