Árvore de páginas


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Professionals - Retorna os profissionais de saúde 
  3. Tela api professionals
    1. Outras Ações / Ações relacionadas
  4. Tela api professionals
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade professionals (Profissionais de saúde) 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.


02. EXEMPLO DE UTILIZAÇÃO

Professionals - Retorna os profissionais de saúde

Retorna os profissionais de saúde cadastrados na operadora.

/totvsHealthPlans/attendanceNetwork/v1/professionals

GET

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
healthInsurerCode (query)stringCódigo da operadora (BB0_CODOPE)*required
idOnHealthInsurer (query)stringFiltro de profissionais pelo código no sistema (BB0_CODIGO)
name (query)stringFiltro de professionais pelo nome (BB0_NOME)
professionalCouncil (query)string

Filtro de profissionais pela sigla do conselho regional (BB0_CODSIG)


professionalCouncilNumber (query)string

Filtro de profissionais pelo numero do conselho regional (BB0_NUMCR)


stateAbbreviation (query)stringFiltro de profissionais pelo estado do conselho regional (BB0_ESTADO)
professionalIdentifier (query)stringFiltro de profissionais pelo CPF/CNPJ (BB0_CGC)
healthInsurerCodeOrigem (query)stringFiltro de profissionais pelo código da operadora origem do profissional (BB0_CODORI)
page (query)

string

Valor numérico (maior que zero) representando a página solicitada
pageSize (query)

string

Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)

string

Lista de campos para ordenação, separada por virgula (,).
fields (query)

string

Lista com o nome das propriedades JSON que serão retornadas.
filter (query)

string

Filtros seguindo o padrão ODATA

Body


Não possui body!

hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de profissionais

items.id_on_health_insurerstring

Código do profissional no sistema

BB0_CODIGO*required
items.namestring

Nome do profissional

BB0_NOME*required
items.professional_councilstringSigla Conselho RegionalBB0_CODSIG*required
items.professional_council_numberstringNumero Conselho Regional BB0_NUMCR*required
items.state_abbreviationstringEstado Conselho Regional BB0_ESTADO*required
items.professional_identifierstringCPF/CNPJ do profissionalBB0_CGC
items.healthInsurer_code_origemstring

Código da operadora origem do profissional

BB0_CODORI
items.is_part_attendance_networkstring

Identifica se o profissional faz parte da rede de atendimento, sendo:

  • 1 = Faz parte da Rede de Atendimento
  • 2 = Não faz parte da Rede de Atendimento                                                       
BB0_VINC*required
items.blocking_reasonstringCódigo do bloqueio do profissionalBB0_CODBLO
items.blocking_datestring (date)Data do bloqueio do profissionalBB0_DATBLO
Exemplo
{
    "items": [
        {
            "id_on_health_insurer": "000052",
            "name": "RDA CRUZEIRO",
            "professional_council": "CRM",
            "professional_council_number": "2165465454",
            "state_abbreviation": "SP",
            "professional_identifier": "34622099000185",
            "health_insurer_code_origem": "",
            "is_part_attendance_network": "1",
            "blocking_reason": "",
            "blocking_date": ""
        },
        {
            "id_on_health_insurer": "000055",
            "name": "W RDA XML EXECUTANTE",
            "professional_council": "CRM",
            "professional_council_number": "1111",
            "state_abbreviation": "SP",
            "professional_identifier": "31233647040",
            "health_insurer_code_origem": "",
            "is_part_attendance_network": "1",
            "blocking_reason": "",
            "blocking_date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 29
}
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": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave healthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave healthInsurerCode."
        }
    ]
}

03. TELA API PROFESSIONALS

Outras Ações / Ações relacionadas

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

04. TELA API PROFESSIONALS

Principais Campos e Parâmetros

CampoDescrição
BB0_CODIGOCódigo do profissional no sistema
BB0_NOME

Nome do profissional

BB0_CODSIGSigla Conselho Regional
BB0_NUMCRNumero Conselho Regional 
BB0_ESTADOEstado Conselho Regional 
BB0_CGCCPF/CNPJ do profissional

05. TABELAS UTILIZADAS

  • Profissionais de saúde (BB0)