Histórico da Página
...
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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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"
}
]
} |
...
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 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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": ""
}
]
} |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas