List

Lista de Concelhos

Fornece uma Lista de todos os Concelhos existentes.

GET https://api.cloudinvoice.net/localities/

Query Parameters

Name	Type	Description
limit	integer	Define o número de países por pesquisa.
offset	integer	Indica a posição inicial da pesquisa. Retorna a lista de países compreendida entre offset:offset+limit.
ordering	string	Define o campo e a direcção a usar na pesquisa de países. Campos ordenáveis: id, code, search_order, country_name. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.
search	string	Define o termo de pesquisa a utilizar na lista de países. Campos Pesquisados: Código, Nome do País, Ordem de Pesquisa
code	string	Código do Concelho Para pesquisa parcial pode usar o formato: "code__search"
description	string	Descrição Para pesquisa parcial pode usar o formato: "description__search"

200: OK Lista de Concelhos

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

curl https://api.cloudinvoice.net/localities/
    -H "Content-Type: application/json"

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 309,
    "next": "https://api.cloudinvoice.net/localities/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "01",
            "description": "Águeda",
            "zip_code": "375",
            "district_id": 1,
            "district": {
                "code": "01",
                "description": "Aveiro"
            }
        },
        {
            "id": 2,
            "code": "02",
            "description": "Albergaria-a-Velha",
            "zip_code": "385",
            "district_id": 1,
            "district": {
                "code": "01",
                "description": "Aveiro"
            }
        },
        ...
    ]
}

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.