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íticasCódigo de Erro
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

...

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:

...

code	String	Código identificador do erro. (Tabela de CríticasErro)	*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.

...

code	String	Código identificador do erro. (Tabela de CríticasErro)	*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": "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):

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 00000000000000000 inválida.	Matrícula deve ter o tamanho de 17 caracteres: BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO
BL03	Matrícula 00000000000000000 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 00000000000000000 deve ser de maior para realizar a solicitação.	Calculo da idade do beneficiário realizada pelo campo BA1_DATNAS
BL05	Beneficiário dependente 00000000000000000 só pode realizar a solicitação para ele mesmo.	Informado o atributo 'beneficiaries' no body da requisição.
BL06	Beneficiário 00000000000000000 já está bloqueado.	Campo BA1_MOTBLO do beneficiário já preenchido.
BL07	Beneficiário 00000000000000000 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 00000000000000000 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)"

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 402
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

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave