List

Lista de Famílias

Fornece uma Lista de todas as Famílias existentes.

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

Query Parameters

Name	Type	Description
limit	integer	Define o número de famílias por pesquisa.
offset	integer	Indica a posição inicial da pesquisa. Retorna a lista de famílias compreendida entre offset:offset+limit.
ordering	string	Define o campo e a direcção a usar na pesquisa.
search	string	Define o termo de pesquisa a utilizar na lista.
code	string	Código da Família. 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 famílias

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

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

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 37,
    "next": "https://api.cloudinvoice.net/families/?limit=10&offset=10",
    "previous": null
    "results": [
        {
            "id": 1,
            "code": "1",
            "description": "Familia 1",
            "photo_image_path": null,
            "button_background_color": 3,
            "is_disable_touch": false,
            "obs": ""
        },
        ...
    ]
}

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.