CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. RegionalCouncils - Retorna os conselhos regionais
  3. Tela api regionalCouncils
    1. Outras Ações / Ações relacionadas
  4. Tela api regionalCouncils
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade RegionalCouncils (Conselhos Regionais) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de 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

Retorna os conselhos regionais cadastrados no sistema.

/totvsHealthPlans/attendanceNetwork/v1/regionalCouncils

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
code (query)stringFiltro de conselhos regionais pelo código (BAH_CODIGO)
description (query)stringFiltro de conselhos regionais pela descrição (BAH_DESCRI)
codeTiss (query)string

Filtro de conselhos regionais pelo código TISS (BTU_CDTERM)

(Quando houver vinculo TISS)


descriptionTiss (query)string

Filtro de conselhos regionais pela descrição TISS (BTQ_DESTER)

(Quando houver vinculo TISS)


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 conselhos regionais

items.codestring

Código do conselho regional

BAH_CODIGO*required
items.descriptionstring

Descrição do conselho regional

BAH_DESCRI

items.code_tiss

stringCódigo TISS do conselho regionalBTU_CDTERM
items.description_tissstringDescrição TISS do conselho regionalBTQ_DESTER
{
    "items": [
        {
            "code": "COREN",
            "description": "CONSELHO REGIONAL DE ENFERMAGEM",
            "code_tiss": "",
            "description_tiss": ""
        },
        {
            "code": "CRFA",
            "description": "CONSELHO REGIONAL DE FONOAUDIOLOGIA",
            "code_tiss": "",
            "description_tiss": ""
        },
        {
            "code": "CRFITO",
            "description": "CONSELHO REGIONAL DE FISIOTERAPIA OCUPACIONAL",
            "code_tiss": "",
            "description_tiss": ""
        },
        {
            "code": "CRM",
            "description": "CONSELHO REGIONAL DE MEDICINA",
            "code_tiss": "06",
            "description_tiss": "Conselho Regional de Medicina (CRM)"
        },
        {
            "code": "CRN",
            "description": "CONSELHO REGIONAL DE NUTRICAO",
            "code_tiss": "",
            "description_tiss": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 2
}

03. TELA REGIONALCOUNCILS

Outras Ações / Ações relacionadas

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

04. TELA REGIONALCOUNCILS

Principais Campos e Parâmetros

CampoDescrição
BAH_CODIGOCódigo do Conselho Regional
BAH_DESCRIDescrição do Conselho Regional

05. TABELAS UTILIZADAS