API Cities - v1.000 (Locality)

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Cities - Retorna os municípios
Tela api cities
1. Outras Ações / Ações relacionadas
Tela api cities
1. Principais Campos e Parâmetros
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

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

cities - Retorna os municípios

Retorna os municípios (cidades) cadastrados no sistema.

/totvsHealthPlans/locality/v1/cities

GET

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
cityCode (query)	string	Filtro de municípios pelo código IBGE
cityDescription (query)	string	Filtro de municípios pela nome/descrição
stateAbbreviation (query)	string	Filtro 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

Request

Body

Não possui body!

(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 municípios
items.city_code	string	Código IBGE do município	BID_CODMUN	*required
items.city_description	string	Nome do município	BID_DESCRI	*required
items.state_abbreviation	string	UF do estado do município	BID_EST	*required

Exemplo

{
    "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ção	Descrição
Não se aplica	Não se aplica

04. TELA API CITIES

Principais Campos e Parâmetros

Campo	Descrição
BID_CODMUN	Código do município
BID_DESCRI	Nome do município
BID_EST	UF do estado do município

05. TABELAS UTILIZADAS

Municípios (BID)

Árvore de páginas