Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Novo Protocolo de Bloqueio
2. Consultar Dados de Bloqueio
3. Tabela de Críticas
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

...

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)

code	String	Código identificador do erro. (Tabela de Críticas)	*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
helpUrl	String	URI para documentação do erro.
details	Array

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

Consultar Dados de Bloqueio

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

Endpoint

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

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

Exemplo

Sem Body

...

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)

code	String	Código identificador do erro. (Tabela de Críticas)	*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
helpUrl	String	URI para documentação do erro.
details	Array

Bloco de código

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

{
    "code": "BL07BL03",
    "message": "BeneficiárioMatrícula 0001100800001601800011008000016019 jánão tem uma solicitação pendentefoi encontrada.",
    "detailedMessage": "BeneficiárioMatricula comnão solicitação pendenteencontrada na tabela BA1 B5Jpela com o B5J_STATUS igual a 0.chave: BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Dados Inválidos (400)

Consultar Dados de Bloqueio

Endpoint

Parâmetros

Request

Exemplo

Operação realizada com sucesso (200)

Exemplo

Dados Inválidos (400)