CONTEÚDO
- Visão Geral
- URL
- JSON
01. VISÃO GERAL
Esse documento tem como objetivo mostrar o JSON responsavel pela integração do cadastro de Cidades. Para mais informações sobre o funcionamento das integrações no TOTVS Pesagem, acessar Configuração e funcionamento da integração no TOTVS Pesagem.
02. URL
Na API de Cidade, por padrão, o TOTVS Pesagem, aguarda as seguinte URL para fazer a chamada da API GET: http://ip:porta/contexto/v1/cities/"instância"
OBS: A instância é recuperada no TOTVS Pesagem. É o campo TOTVS Pesagem → Configurações → Gerais → Instância
03. JSON
Exemplo do JSON de Cidades
{
"hasNext": false,
"items": [
{
"id": "7928740212848124053",
"countyCode": 1,
"countyDescription": "Assis",
"federativeUnit": {
"cdUf": "SP"
}
},
{
"id": "7426398837856345433",
"countyCode": 2,
"countyDescription": "Rio de Janeiro",
"federativeUnit": {
"cdUf": "RJ"
}
}
],
"length": 2
}
Atributos
Nome | Descrição |
---|---|
id | Identificador, é a chave primária, pode ser enviado, caso não seja é gerado no TOTVS Pesagem |
countyCode | Código |
countyDescription | Descrição |
federativeUnit/cdUf | Código da Unidade Federativa. Cadastro de Unidade Federativa no TOTVS Pesagem. |