For the complete documentation index, see llms.txt. This page is also available as Markdown.

List

Fornece uma lista de todos os distritos existentes.

Listar Distritos

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

Query Parameters

Name
Type
Description

limit

integer

Define o número de registos por pesquisa.

offset

integer

Indica a posição inicial da pesquisa.

Retorna a lista de registos compreendida entre offset e offset+limit.

ordering

string Default: "description"

Define o campo e a direção a usar na pesquisa de registos.

Campos ordenáveis:

  • id, code, description, country

Use '-' antes do nome para ordem decrescente.

search

string

Define o termo de pesquisa a utilizar na lista de registos.

Campos Pesquisados:

  • code, description, country

code

string

Código

Sufixos disponíveis:

  • __search: para pesquisa parcial

description

string

Descrição

Sufixos disponíveis:

  • __search: para pesquisa parcial

country

integer

ID do País

curl https://api.cloudinvoice.net/districts/
    -H "Content-Type: application/json"
{
    "limit": 10,
    "offset": 0,
    "count": 29,
    "next": "https://api.cloudinvoice.net/districts/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "01",
            "description": "Aveiro",
            "territory_id": 101,
            "country_id": 1,
            "country": {
                "code": "PT",
                "country_name": "Portugal"
            },
            "territory": {
                "code": "CO",
                "description": "Continente"
            }
        },
        {
            "id": 2,
            "code": "02",
            "description": "Beja",
            "territory_id": 101,
            "country_id": 1,
            "country": {
                "code": "PT",
                "country_name": "Portugal"
            },
            "territory": {
                "code": "CO",
                "description": "Continente"
            }
        },
        ...
    ]
}

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

Last updated