API totvsHealthPlans - Protocolo de Bloqueio dos Beneficiários

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
   1. Novo Protocolo de Bloqueio
   2. Consultar Dados de Bloqueio
   3. Tabela de Código de Erro
3. Tela Bloqueio dos Beneficiários
   1. Outras Ações / Ações relacionadas
      
4. Tela Bloqueio dos Beneficiários
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização do endpoint Protocolo de Bloqueio dos Beneficiários que pertence a API padrão do produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).

Os protocolos serão gerados pelo endpoint na rotina de Solic. Cancel. Planos (PLSA99B) para que a Operadora analise as solicitações.

Clique aqui para detalhes sobre como habilitar o serviço de APIs

02. EXEMPLO DE UTILIZAÇÃO

Novo Protocolo de Bloqueio

Para gerar um protocolo de bloqueio para o(s) Beneficiário(s) e necessário configurar os seguintes passos:

Endpoint

Parâmetros

Request

Ao solicitar um protocolo de bloqueio para o titular, o mesmo também poderá solicitar o bloqueio de toda a família, através do atributo familyBlock igual a true, ou também poderá solicitar o bloqueio somente de determinados beneficiários através do atributo beneficiaries. Ambos os atributos (familyBlock e beneficiaries) são opcionais.

{
    "familyBlock": false,
    "beneficiaries":[
        {
            "subscriberId": "00011008000016034"
        }
    ]
}

Operação realizada com sucesso (200)

{
    "blockingDate": "",
    "blockingReason": "",
    "blockingProtocol": [
        {
            "requestDate": "2022-06-24",
            "requestOrigin": "3",
            "status": "0",
            "protocol": "41750520220624000009"
        }
    ]
}

Dados Inválidos (400) 

{
    "code": "BL07",
    "message": "Beneficiário 00011008000016018 já tem uma solicitação pendente.",
    "detailedMessage": "Beneficiário com solicitação pendente na tabela B5J com o B5J_STATUS igual a 0.",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

Consultar Dados de Bloqueio

Retorna os dados referente ao bloqueio do beneficiário solicitado.

Endpoint

Parâmetros

Request

Sem Body

Operação realizada com sucesso (200)

{
    "blockingDate": "",
    "blockingReason": "",
    "blockingProtocol": [
        {
            "requestDate": "2022-06-24",
            "requestOrigin": "3",
            "status": "0",
            "protocol": "41750520220624000009"
        }
    ]
}

Dados Inválidos (400) 

{
    "code": "BL03",
    "message": "Matrícula 00011008000016019 não foi encontrada.",
    "detailedMessage": "Matricula não encontrada na tabela BA1 pela chave: BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

Tabela de Código de Erro

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

Veja um exemplo de como é feita a comunicação com Endpoint de Protocolo de Bloqueio dos beneficiários na prática: 

03. TELA BLOQUEIO DOS BENEFIÁRIOS

Outras Ações / Ações relacionadas

04. TELA BLOQUEIO DOS BENEFIÁRIOS

Principais Campos e Parâmetros

05. TABELAS UTILIZADAS

• BA1 - Beneficiários
• B5J - Solicitação Cancelamento Plano
• B5K - Usuários Solic. Canc. Plano