List

Lista de Países

Fornece uma Lista de todos os Países existentes.

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

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
country_name	string	Nome do País. Para pesquisa parcial pode usar o formato: "country_name__search"
code	string	Código do País Para pesquisa parcial pode usar o formato: "code__search"
search_order	integer	Ordem de Pesquisa

200: OK Lista de países

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

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

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 39,
    "next": "https://api.cloudinvoice.net/countries/?limit=10&offset=10",
    "previous": null
    "results": [
    {
            "id": 1,
            "code": "PT",
            "country_name": "Portugal",
            "is_eu": true,
            "search_order": 1
        },
        {
            "id": 2,
            "code": "ES",
            "country_name": "Espanha",
            "is_eu": true,
            "search_order": 2
        },
        ...
    ]
}

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

Notas: Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.