CONTEÚDO
- Visão Geral
- Exemplo de utilização
- cities - Retorna os municípios
- Tela api cities
- Outras Ações / Ações relacionadas
- Tela api cities
- 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
| Dica |
|---|
| title | 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. |
| Informações |
|---|
| title | Nomenclatura das APIs |
|---|
|
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
| Painel |
|---|
| titleColor | Orange |
|---|
| borderStyle | solid |
|---|
| title | cities - Retorna os municípios |
|---|
|
Retorna os municípios (cidades) cadastrados no sistema. | /totvsHealthPlans/locality/v1/cities | |
| Nota |
|---|
| Expandir |
|---|
| | Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | | city-code (query) | string | Filtro de municípios pelo código IBGE |
| | city-description (query) | string | Filtro de municípios pela nome/descrição |
| | state-abbreviation (query) | string | Filtro de municípios pelo estado |
| | page (query) | | Valor numérico (maior que zero) representando a página solicitada |
| | pageSize (query) | | Valor numérico (maior que zero) representando o total de registros retornados na consulta |
| | order (query) | | Lista de campos para ordenação, separada por virgula (,). |
| | fields (query) | | Lista com o nome das propriedades JSON que serão retornadas. |
| | filter (query) | | Filtros seguindo o padrão ODATA |
|
|
|
| Dica |
|---|
| Expandir |
|---|
| 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 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 |
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Emacs |
|---|
| title | Exemplo |
|---|
| linenumbers | true |
|---|
| {
"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
