Histórico da Página

...

Visão Geral
Exemplo de utilização
Tela Bloqueio dos Beneficiários
1. Outras Ações / Ações relacionadas
Tela Bloqueio dos Beneficiários
1. Principais Campos e Parâmetros
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

...

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

Endpoint

Url	Verbo
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaries/{subscriberId}/block	POST

Parâmetros

subscriberId (path)	String	Número da carteirinha do beneficiário a ser solicitado	*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

familyBlock	Lógico	Bloqueia toda a família (Somente quando o solicitante for o titular)
beneficiaries	Array	Lista com beneficiários da família a serem bloqueados.
beneficiaries.subscriberId	String	Número da carteirinha do beneficiário

Ao solicitar um protocolo de bloqueio para o títular, 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. Ambos os atributos (familyBlock e beneficiaries) são opcionais.

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

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

Operação realizada com sucesso (200)

blockingDate	Date	Data de bloqueio do beneficiário solicitado (BA1_DATBLO)
blockingReason	String	Motivo de bloqueio do beneficiário solicitado (BA1_MOTBLO)
blockingProtocol	Array	Dados do protocolo de bloqueio do beneficiário, caso tenha.
blockingProtocol.requestDate	Date	Data de solicitação do bloqueio (B5J_DATSOL)
blockingProtocol.requestOrigin	String	Origem da solicitação do bloqueio (B5J_ORISOL)
blockingProtocol.status	String	Status do protocolo de bloqueio (B5J_STATUS)
blockingProtocol.protocol	String	Protocolo de bloqueio (B5J_PROTOC)

Exemplo

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

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

Dados Inválidos (400)

blockingDate	Date	Data de bloqueio do beneficiário solicitado (BA1_DATBLO)
blockingReason	String	Motivo de bloqueio do beneficiário solicitado (BA1_MOTBLO)
blockingProtocol	Array	Dados do protocolo de bloqueio do beneficiário, caso tenha.
blockingProtocol.requestDate	Date	Data de solicitação do bloqueio (B5J_DATSOL)
blockingProtocol.requestOrigin	String	Origem da solicitação do bloqueio (B5J_ORISOL)
blockingProtocol.status	String	Status do protocolo de bloqueio (B5J_STATUS)
blockingProtocol.protocol	String	Protocolo de bloqueio (B5J_PROTOC)

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

{
    "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": ""
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Endpoint

Parâmetros

Request

Exemplo

Operação realizada com sucesso (200)

Exemplo

Dados Inválidos (400)