Exibir origem

CONTEÚDO

Visão Geral
Configurações INI
Verbos
Path Param
Exemplos de Jsons de Resposta

01. VISÃO GERAL

A API BeneficiaryElegibility tem como objetivo retornar dados do beneficiário e seu titular, conforme solicitação que pode ser por CPF, MATRICULA ou MATRICULA ANTIGA.

Esta API utiliza função padrão do produto para processamento da requisição. Função principal - PLVLDUSRP e função auxiliar - PLSA090USR.

Obs.: caso informado o query param eligibilityType como "pet", a elegibilidade será feita para um animal de estimação, buscando-o pelo CPF do responsável pelo animal de estimação (BA1_CPFTIT) informado no query param cardNumberOrCpf.

02. CONFIGURAÇÕES INI

Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:

Configuração do REST Protheus

Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /totvsHealthPlans/v1/BeneficiaryElegibility.

Exemplo:

Linha Microsiga Protheus > API BeneficiaryElegibility - Elegibilidade > image2020-12-17_15-28-30.png

Logo, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/BeneficiaryElegibility?cardNumberOrCpf={cardOrcpf}

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo	Path	Descrição
GET	/BeneficiaryElegibility	Elegibilidade do Beneficiário

04. PATH PARAMS - GET

Lista de query params obrigatórios:

Campo	Descrição
cardNumberOrCpf	Cpf (do beneficiário ou do responsável pelo animal de estimação) ou matrícula/ matrícula antiga do beneficiário

Lista de query params opcionais:

Campo

Descrição

eligibilityType

Tipo da elegibilidade.

Por padrão a elegibilidade será realizada para um beneficiário, porém quando informado "pet", será realizada a elegibilidade para um animal de estimação, através do CPF do responsável que deve ser informado no query param cardNumberOrCpf.

authorizationType

Tipo da guia que verificará a elegibilidade.

Exemplo de chamada para utilização de um beneficiário em Dezembro de 2017:

http://localhost:8080/rest/totvsHealthPlans/v1/BeneficiaryElegibility?cardNumberOrCpf=00010001000003002

05. EXEMPLOS DE JSONS DE RESPOSTA

Sucesso 200

{
 "beneficiaries": [
 {
 "rejectionCauses": [],
 "beneficiary": {
 "gender": "2",
 "phoneNumber": "",
 "subscriberId": "00010001000003002",
 "companyName": "SUB CONTRATO PESSOA JURIDICA",
 "age": 49,
 "cardExpiration": "2018-12-21",
 "holderRelationship": "T",
 "newbornAttendance": "S",
 "holderCPF": "22701624800",
 "isInterchange": false,
 "whenToCharge": "2",
 "birthdate": "1972-12-01",
 "isOwner": true,
 "CNS": "801641924550001",
"inclusionDate": "2020-05-30",
 "oldSubscriberId": "",
 "name": "USUARIO - 00010001000003002",
 "healthInsurance": {
 "code": "0005",
 "roomType": "12",
 "description": "PRODUTO MEDICO"
 },
 "weight": "0.00",
 "socialName": "USUARIO - 00010001000003002",
 "height": "0.00"
 },
 "warnings": [],
 "elegibilityResponse": "S"
 },
 {
 "rejectionCauses": [
 {
 "idTiss": "1014",
 "code": "506",
 "alert": false,
 "interchangeCode": null,
 "detail": "Somente guias ate 17/01/18 serao validas.  ;Data do Evento 13/04/22 ;Periodo do Bloqueio De 18/01/18 Até 13/04/24 ;Motivo do Bloqueio 001 - A PEDIDO DA DIRETORIA (NAO USA ;Nível: BA1 - Usuários 06 - Atualizações / Contrato - Família / Família-Usuário / Folder Usuário ;",
 "description": "BENEFICIARIO COM DATA DE EXCLUSAO"
 },
 {
 "idTiss": "1799",
 "code": "037",
 "alert": false,
 "interchangeCode": null,
 "detail": "Data de validade do cartao magnetico 21/12/18 ;Data do atendimento 13/04/22 ;Qtd. de dias ultrapassados 1209 ;Nível: BA1 - Usuários 11 - Atualizações / Contrato - Família / Família-Usuário / Folder Usuário ;",
 "description": "OUTROS"
 }
 ],
 "beneficiary": {
 "gender": "2",
 "phoneNumber": "",
 "subscriberId": "00010001000010009",
 "companyName": "SUB CONTRATO PESSOA JURIDICA",
 "age": 49,
 "cardExpiration": "2018-12-21",
 "holderRelationship": "T",
 "newbornAttendance": "S",
 "holderCPF": "22701624800",
 "isInterchange": false,
 "whenToCharge": "2",
 "birthdate": "1972-12-01",
 "isOwner": true,
 "CNS": "801641924550001",
"inclusionDate": "2020-05-30",
 "oldSubscriberId": "",
 "name": "USUARIO - 00010001000010009",
 "healthInsurance": {
 "code": "0005",
 "roomType": "12",
 "description": "PRODUTO MEDICO"
 },
 "weight": "0.00",
 "socialName": "USUARIO - 00010001000010009",
 "height": "0.00"
 },
 "warnings": [],
 "elegibilityResponse": "S"
 },
 {
 "rejectionCauses": [
 {
 "idTiss": "1799",
 "code": "004",
 "alert": false,
 "interchangeCode": null,
 "detail": "Parcela(s) em Aberto 1 ;Dias Atrasados (dias corridos ref titulo em aberto mais antigo) 92 ;Saldo Original 200.00 ;",
 "description": "OUTROS"
 }
 ],
 "beneficiary": {
 "gender": "2",
 "phoneNumber": "",
 "subscriberId": "00010013000002000",
 "companyName": "NOGUEIRA",
 "age": 49,
 "cardExpiration": "",
 "holderRelationship": "T",
 "newbornAttendance": "S",
 "holderCPF": "22701624800",
 "isInterchange": false,
 "whenToCharge": "2",
 "birthdate": "1972-12-01",
 "isOwner": true,
 "CNS": "801641924550001",
"inclusionDate": "2020-05-30",
 "oldSubscriberId": "",
 "name": "USUARIO - 00010013000002000",
 "healthInsurance": {
 "code": "0001",
 "roomType": "11",
 "description": "PRODUTO EXEMPLO 1"
 },
 "weight": "0.00",
 "socialName": "USUARIO - 00010013000002000",
 "height": "0.00"
 },
 "warnings": [],
 "elegibilityResponse": "S"
 },
 {
 "rejectionCauses": [
 {
 "idTiss": "1799",
 "code": "004",
 "alert": false,
 "interchangeCode": null,
 "detail": "Parcela(s) em Aberto 1 ;Dias Atrasados (dias corridos ref titulo em aberto mais antigo) 2 ;Saldo Original 200.00 ;",
 "description": "OUTROS"
 }
 ],
 "beneficiary": {
 "gender": "2",
 "phoneNumber": "",
 "owner": {
 "gender": "1",
 "phoneNumber": "",
 "subscriberId": "00011060000006010",
 "companyName": "10 ANO DE PLANO E 60 ANOS DE IDADE",
 "age": 49,
 "cardExpiration": "",
 "holderRelationship": "T",
 "newbornAttendance": "S",
 "holderCPF": "74827314233",
 "isInterchange": false,
 "whenToCharge": "2",
 "birthdate": "1972-12-01",
 "isOwner": false,
 "CNS": "287611986630008",
"inclusionDate": "2020-05-30",
 "oldSubscriberId": "",
 "name": "USUARIO - 00011060000006010",
 "healthInsurance": {
 "code": "0007",
 "roomType": "11",
 "description": "PRODUTO PARA TESTES DO NIVES D"
 },
 "weight": "0.00",
 "socialName": "USUARIO - 00011060000006010",
 "height": "0.00"
 },
 "subscriberId": "00011060000006029",
 "companyName": "10 ANO DE PLANO E 60 ANOS DE IDADE",
 "age": 49,
 "cardExpiration": "",
 "holderRelationship": "D",
 "newbornAttendance": "S",
 "holderCPF": "22701624800",
 "isInterchange": false,
 "whenToCharge": "2",
 "birthdate": "1972-12-01",
 "isOwner": false,
 "CNS": "801641924550001",
"inclusionDate": "2020-05-30",
 "oldSubscriberId": "",
 "name": "USUARIO - 00011060000006029",
 "healthInsurance": {
 "code": "0007",
 "roomType": "11",
 "description": "PRODUTO PARA TESTES DO NIVES D"
 },
 "weight": "0.00",
 "socialName": "USUARIO - 00011060000006029",
 "height": "0.00"
 },
 "warnings": [],
 "elegibilityResponse": "S"
 }
 ],

"numberofplans": 4,
    "serviceResponse": true,
    "authorizationType": null,
    "journey": null
}

Erro 200

1
2
3
4

{
"hasError": true,
"errorMessage": "Não foi informado o CPF ou MATRICULA"
}