Vai al contenuto

Ordinamento e filtri

Gli endpoint che restituiscono liste accettano i parametri Order e Filter, che permettono di ordinare e filtrare i risultati lato server, recuperando esattamente i dati che ti servono.

Ordinamento

Il parametro Order è una lista di proprietà separate da virgola. Un segno meno (-) davanti al nome indica ordine discendente.

GET /api/v3/1/contatto?Order=-RagioneSociale1,Citta

In questo esempio i contatti vengono ordinati per RagioneSociale1 in ordine discendente e, a parità, per Citta in ordine ascendente.

Filtri

Il parametro Filter è una lista di condizioni separate da virgola. Ogni condizione è formata da nome campo, operatore, valore ed eventuale connettore logico.

Operatori

Operatore Significato
$eq uguale a
$ne diverso da
$gt maggiore di
$gte maggiore o uguale a
$lt minore di
$lte minore o uguale a
$ct contiene
$nct non contiene
$sw inizia con
$ew finisce con

Connettori logici

Connettore Significato
$and AND logico (predefinito, può essere omesso)
$or OR logico

Le sotto-query si racchiudono tra parentesi quadre [].

Esempi

Contatti la cui ragione sociale contiene "acme" oppure con fido superiore a 1000:

GET /api/v3/1/contatto?Filter=RagioneSociale1 $ct acme $or, Fido $gt 1000

Codifica URL

Il valore di Filter contiene spazi e il carattere $, che vanno inviati codificati in URL. Per esempio nome $ct cina diventa nome%20%24ct%20cina. Gli SDK e gli strumenti come Postman se ne occupano automaticamente.