CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. UnreferencedNetworks - Retorna as redes não referenciadas
  3. Tela api unreferencedNetworks 
    1. Outras Ações / Ações relacionadas
  4. Tela api unreferencedNetworks 
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade UnreferencedNetworks (Redes Não Referenciadas) 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.

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

Retorna as redes não referenciadas cadastradas no sistema

/totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworks

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 redes não referenciadas pelo código no sistema (BK6_CODIGO)
name (query)stringFiltro de redes não referenciadas pelo nome (BK6_NOME)
identifier (query)string

Filtro de redes não referenciadas pelo CPF/CNPJ (BK6_CGC)


council (query)string

Filtro de redes não referenciadas pela sigla do conselho regional (BK6_SIGLA)


council-number (query)stringFiltro de redes não referenciadas pelo numero do conselho regional (BK6_CONREG)
council-state-abbreviation (query)stringFiltro de redes não referenciadas pelo estado do conselho regional (BK6_ESTCR)
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 da rede não referenciada no sistema

BK6_CODIGO*required
items.namestring

Nome da rede não referenciada

BK6_NOME
items.councilstringSigla do conselho regional da rede não referenciadaBK6_SIGLA
items.council-numberstringNumero do conselho regional da rede não referenciadaBK6_CONREG
items.council-state-abbreviationstringEstado do conselho regional da rede não referenciadaBK6_ESTCR
items.identifierstringCPF/CNPJ da rede não referenciadaBK6_CGC
items.city-codestringCódigo do município da rede não referenciadaBK6_MUNCR
items.city-code-residencestringDescrição do municípioBID_DESCRI
{
    "items": [
        {
            "code": "000001",
            "name": "TESTERS",
            "council": "CRM",
            "council-number": "14569877",
            "council-state-abbreviation": "",
            "identifier": "62996640000150",
            "city-code": "",
            "city-code-residence": ""
        },
        {
            "code": "000002",
            "name": "ADGREGETHGT",
            "council": "",
            "council-number": "",
            "council-state-abbreviation": "",
            "identifier": "90846127000119",
            "city-code": "",
            "city-code-residence": ""
        },
        {
            "code": "000002",
            "name": "PRESTADOR DE DIFERENTE VALOR",
            "council": "",
            "council-number": "",
            "council-state-abbreviation": "",
            "identifier": "57522658322463",
            "city-code": "",
            "city-code-residence": ""
        },
        {
            "code": "000002",
            "name": "JOSE",
            "council": "",
            "council-number": "",
            "council-state-abbreviation": "SP",
            "identifier": "77077733000159",
            "city-code": "3500105",
            "city-code-residence": "ADAMANTINA"
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}

03. TELA UNREFERENCEDNETWORKS

Outras Ações / Ações relacionadas

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

04. TELA UNREFERENCEDNETWORKS

Principais Campos e Parâmetros

CampoDescrição
BK6_CODIGOCódigo da rede não referenciada no sistema
BK6_NOME

Nome da rede não referenciada

BK6_SIGLASigla do conselho regional da rede não referenciada
BK6_CONREGNumero do conselho regional da rede não referenciada
BK6_ESTCREstado do conselho regional da rede não referenciada
BK6_CGCCPF/CNPJ da rede não referenciada

05. TABELAS UTILIZADAS