Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	BlockContract BlockContracts - Realiza o Bloqueio direto do Beneficiário

Realiza o bloqueio do contrato do beneficiário

/totvsHealthPlans/familyContract/v1/beneficiaries/blockContracts

POST

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
subscriberId (body)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)	*required
dateBlock (body)	string(date)	Data do bloqueio ("21-09-2023")	*required
reason (body)	string	Código do motivo de bloqueio	*required
observation (body)	string	Observação sobre o bloqueio
deathCodeSIP (body)	string	Código do óbito SIP
dateRequested (body)	string(date)	Data da requisição do bloqueio ("12-09-2023")
blockFamily (body)	boolean	Campo lógico sobre bloqueio da família

Dica

Expandir

title	Request

Body

{
"subscriberId": "00011078000002018",
"dateBlock": "2023-09-12",
"reason": "001",
"observation": "Bloqueio por pedido do Titular",
"deathCodeSIP": "1.32",
"dateRequested": "2023-09-12",
"blockFamily": "false"
}

Dica

Expandir

title	(200) - Operação realizada com sucesso

beneficiaries	array	Beneficiários	*required
subscriberId	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)	*required
beneficiarie	string	Nome do beneficiário	*required
date	string(date)	Data do bloqueio	*required
reason	string	Código do motivo de bloqueio	*required
reasonDescription	string	Descrição do motivo de bloqueio	*required
observation	array	Observação sobre o bloqueio	*required
blockInvoicing	string	Bloqueia Faturamento (1=Sim, 0=Nao)	*required
dateRequested	string(date)	Data de requisição do bloqueio	*required
dateEntry	string(date)	Data de lançamento do bloqueio	*required
hourRequested	string	Hora do lançamento do bloqueio	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "beneficiaries": [
        {
            "subscriberId": "00011078000002034",
            "beneficiarie": "ISABELLA YASMIN MELO",
            "date": "20230920",
            "reason": "001",
            "reasonDescription": "FIM DA RELACAO BENEF X TITULAR",
            "observation": "Bloqueio por pedido do Titular",
            "blockInvoicing": "1",
            "dateRequested": "20230912",
            "dateEntry": "20230922",
            "hourRequested": "15:16:13"
        }
    ]
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do 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
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        }
    ]
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

code	string	Código identificador do 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
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 27

Nova versão 28

Chave