Linha Microsiga Protheus

Árvore de páginas


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. BlockProtocols - Inclusão de solicitação de cancelamento de planos
  3. Tela api blockProtocols
    1. Outras Ações / Ações relacionadas
  4. Tela api blockProtocols
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade blockProtocols (Protocolos de Cancelamento) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs


Autenticação das APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items


02. EXEMPLO DE UTILIZAÇÃO

BlockProtocols - Inclusão de solicitação de cancelamento de planos

Realiza a inclusão do protocolo de cancelamento de planos do beneficiário.

/totvsHealthPlans/familyContract/v1/blockProtocols

POST

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
subscriberIdstring

Matricula do beneficiário solicitante do cancelamento do plano

(obtido através da API Beneficiaries - v1.000 (Family Contract))

B5J_MATSOL*required

allFamily

boolean

Define que toda a família do beneficiário será bloqueado

(opção somente pra quando o solicitante for o titular)



beneficiariesarrayLista de beneficiário a serem bloqueados

beneficiaries.subscriberIdstring

Matricula do beneficiário a ser bloqueado

(obtido através da API Beneficiaries - v1.000 (Family Contract))

B5K_MATUSU
Exemplo
{
    "subscriberId": "00011078000002018",
    "beneficiaries":
    [
        {
            "subscriberId": "00011078000002018"
        },
        {
            "subscriberId": "00011078000002026"
        }
    ]
}
protocolstringNumero do protocolo gerado do cancelamentoB5J_PROTOC*required
subscriberIdstring

Matricula do beneficiário solicitante

B5J_MATSOL*required
requesterstringNome do beneficiário solicitanteBA1_NOMUSR*required
requestDatestring (date)Data da solicitação de cancelamentoB5J_DATSOL*required
requestTimestringHora da solicitação de cancelamentoB5J_HORSOL*required
emailstringE-mail do beneficiário solicitanteB5J_EMAIL
beneficiariesstring

Beneficiários a serem cancelados do protocolo



beneficiaries.subscriberIdstringMatricula do beneficiárioB5K_MATUSU*required
beneficiaries.namestringNome do beneficiárioBA1_NOMUSR*required
beneficiaries.beneficiaryCPFstring

CPF do beneficiário       

BA1_CPFUSR*required
Exemplo
{
    "protocol": "41750520230620000006",
    "subscriberId": "00011078000002018",
    "requester": "FABIO ANDERSON",
    "requestDate": "2023-06-20",
    "requestTime": "17:25:57",
    "email": "",
    "beneficiaries": [
        {
            "subscriberId": "00011078000002018",
            "name": "FABIO ANDERSON",
            "beneficiaryCPF": "11408812800"
        },
        {
            "subscriberId": "00011078000002026",
            "name": "LOUISE GABRIELLY RAMOS",
            "beneficiaryCPF": "75707526862"
        }
    ]
}
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Exemplo
{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"beneficiaries\":\r\n    [\r\n        {\r\n            \"subscriberId\": \"00011078000002018\"\r\n        },\r\n        {\r\n            \"subscriberId\": \"00011078000002026\"\r\n        }\r\n    ]\r\n}<<"
}
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Exemplo
{
    "code": "E002",
    "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": "E002D-406",
            "message": "Tipo inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ser do tipo (C)."
        }
    ]
}
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Exemplo
{
    "code": "E006",
    "message": "Erro ao incluir solicitação de cancelamento de planos.",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
        {
            "code": "E003E-409",
            "message": "Beneficiário 00011078000002018 já tem uma solicitação pendente.",
            "detailedMessage": "Beneficiário com solicitação pendente na tabela B5J com o B5J_STATUS igual a 0."
        }
    ]
}

03. TELA BLOCKPROTOCOLS

Outras Ações / Ações relacionadas

AçãoDescrição
Não se aplicaNão se aplica

04. TELA BLOCKPROTOCOLS

Principais Campos e Parâmetros

CampoDescrição
B5J_PROTOCNumero do protocolo gerado do cancelamento
B5J_MATSOLMatricula do beneficiário solicitante
B5K_MATUSUMatricula do beneficiário

05. TABELAS UTILIZADAS

  • Beneficiários (BA1)
  • Solicitação Cancelamento Plano (B5J)
  • Usuários Solic. Canc. Plano (B5K)