CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Cities - Retorna os municípios
  3. Tela api cities
    1. Outras Ações / Ações relacionadas
  4. Tela api cities
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade cities (Municípios) 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 municípios (cidades) cadastrados no sistema.

/totvsHealthPlans/locality/v1/cities

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
cityCode (query)string

Filtro de municípios pelo código IBGE


cityDescription (query)string

Filtro de municípios pela nome/descrição


stateAbbreviation (query)stringFiltro de municípios pelo estado
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 municípios

items.city_codestring

Código IBGE do município

BID_CODMUN*required
items.city_descriptionstring

Nome do município

BID_DESCRI*required
items.state_abbreviationstringUF do estado do municípioBID_EST*required
{
    "items": [
        {
            "city_code": "2300101",
            "city_description": "ABAIARA",
            "state_abbreviation": "CE"
        },
        {
            "city_code": "2300150",
            "city_description": "ACARAPE",
            "state_abbreviation": "CE"
        },
        {
            "city_code": "2300200",
            "city_description": "ACARAU",
            "state_abbreviation": "CE"
        }
    ],
    "hasNext": true,
    "remainingRecords": 363
}

03. TELA API CITIES

Outras Ações / Ações relacionadas

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

04. TELA API CITIES

Principais Campos e Parâmetros

CampoDescrição
BID_CODMUNCódigo do município
BID_DESCRINome do município
BID_ESTUF do estado do município

05. TABELAS UTILIZADAS