Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	RegionalCouncils - Retorna os conselhos regionais

Retorna os conselhos regionais cadastrados no sistema.

/totvsHealthPlans/attendanceNetwork/v1/regionalCouncils

GET

Nota

Expandir

title	Parameters

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)	string	Filtro de conselhos regionais pelo código (BAH_CODIGO)
description (query)	string	Filtro de conselhos regionais pela descrição (BAH_DESCRI)
code-tiss codeTiss (query)	string	Filtro de conselhos regionais pelo código TISS (BTU_CDTERM) (Quando houver vinculo TISS)
description-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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de conselhos regionais
items.code	string	Código do conselho regional	BAH_CODIGO	*required
items.description	string	Descrição do conselho regional	BAH_DESCRI
items. code-tiss codeTiss	string	Código TISS do conselho regional	BTU_CDTERM
items.description-tissdescriptionTiss	string	Descrição TISS do conselho regional	BTQ_DESTER

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "code": "COREN",
            "description": "CONSELHO REGIONAL DE ENFERMAGEM",
            "code-tisscodeTiss": "",
            "description-tiss": ""
        },
        {
            "code": "CRFA",
            "description": "CONSELHO REGIONAL DE FONOAUDIOLOGIA",
            "code-tisscodeTiss": "",
            "description-tiss": ""
        },
        {
            "code": "CRFITO",
            "description": "CONSELHO REGIONAL DE FISIOTERAPIA OCUPACIONAL",
            "code-tisscodeTiss": "",
            "description-tiss": ""
        },
        {
            "code": "CRM",
            "description": "CONSELHO REGIONAL DE MEDICINA",
            "code-tisscodeTiss": "06",
            "description-tissdescriptionTiss": "Conselho Regional de Medicina (CRM)"
        },
        {
            "code": "CRN",
            "description": "CONSELHO REGIONAL DE NUTRICAO",
            "code-tisscodeTiss": "",
            "description-tissdescriptionTiss": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 2
}

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave