Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Novo Protocolo de Bloqueio
- Consultar Dados de Bloqueio
- Tabela de Código de Erro
- Tela Bloqueio dos Beneficiários
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Bloqueio dos Beneficiários
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
...
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:
...
Ao solicitar um protocolo de bloqueio para o títulartitular, 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.
Exemplo
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"familyBlock": false,
"beneficiaries":[
{
"subscriberId": "00011008000016034"
}
]
} |
...
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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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 Erro) | *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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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
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) |
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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 Erro) | *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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"code": "BL07BL03",
"message": "BeneficiárioMatrícula 0001100800001601800011008000016019 jánão tem uma solicitação pendentefoi encontrada.",
"detailedMessage": "BeneficiárioMatricula comnão solicitaçãoencontrada pendente na tabela B5J com o B5J_STATUS igual a 0.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):
| Code | message | detailedMessage |
|---|---|---|
| BL01 | Obrigatório informar a matricula do beneficiário como parâmetro. | Parâmetro subscriberId não informado no Endpoint da requisição. |
| BL02 | Matricula {subscriberId} inválida. | Matrícula deve ter o tamanho de 17 caracteres: BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO |
| BL03 | Matrícula {subscriberId} não foi encontrada. | Matricula não encontrada na tabela BA1 pela chave: BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO |
| BL04 | Beneficiário dependente {subscriberId} deve ser de maior para realizar a solicitação. | Calculo da idade do beneficiário realizada pelo campo BA1_DATNAS |
| BL05 | Beneficiário dependente {subscriberId} só pode realizar a solicitação para ele mesmo. | Informado o atributo 'beneficiaries' no body da requisição. |
| BL06 | Beneficiário {subscriberId} já está bloqueado. | Campo BA1_MOTBLO do beneficiário já preenchido. |
| BL07 | Beneficiário {subscriberId} já tem uma solicitação pendente. | Beneficiário com solicitação pendente na tabela B5J com o B5J_STATUS igual a 0. |
| BL08 | Beneficiário {subscriberId} solicitado é de uma família diferente do solicitante. | Campos BA1_CODINT, BA1_CODEMP, BA1_MATRIC diferente dos beneficiarios. |
| BL09 | A solicitação de bloqueio não pode ser realizada para beneficiários de intercâmbio. | Campo BA1_CODEMP do beneficiário é igual a empresa informada no parâmetro MV_PLSGEIN |
| BL10 | "Mensagem de Validação do Modelo de dados (MVC)" | "Mensagem de Validação do Modelo de dados (MVC)" |
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
| Ação | Descrição |
|---|---|
| Não se aplica. | Não se aplica. |
04.
...
TELA BLOQUEIO DOS BENEFIÁRIOS
Principais Campos e Parâmetros
| Campo/Parâmetros | Descrição |
|---|
...
| BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do Beneficiário |
BA1_MOTBLO | Motivo de Bloqueio do Beneficiário |
B5J_PROTOC | Protocolo do Beneficiário na RN 412 |
B5J_STATUS | Status do Protocolo |
MV_PLSGEIN | Código da Empresa de Intercambio |
...
05. TABELAS UTILIZADAS
- BA1 - Beneficiários
- B5J - Solicitação Cancelamento Plano
- B5K - Usuários Solic. Canc. Plano
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas