Endpoint Cidades (v1)
Descrição geral
Cidades
URL
“/public-api/v1/commons/cidade“
Verbos suportados
GET
Status HTTP
• 200 = OK;
• 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.
JSON Exemplo
{"id":1, "codigo":0, "nome":"Texto", "idestado":1, "codigoibge":0, "codigotom":"Texto", "realizaentrega":0}
Exemplos
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cidade
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cidade/${id}
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
id | ID | Inteiro | ||||
codigo | Código de cadastro da cidade | Inteiro | ||||
nome | Nome da cidade | Caractere | 50 | |||
idestado | ID do estado | Inteiro | ||||
codigoibge | Código da cidade conforme tabela oficial IBGE | Inteiro | ||||
codigotom | Código TOM | Caractere | 4 | |||
realizaentrega | Realiza entrega | Inteiro | 0 – Não; 1 – Sim. | |||
Conteúdo Relacionado
Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda