Paginering och frågor

De flesta GET endpoints i Amili API stöder både individuell resurshämtning och paginerad listhämtning:

• Individuell resurs: GET /{resource}/{id} - Returnerar en enda resurs
• Pagerad lista: GET /{resource} - Returnerar en paginerad lista av resurser

Pagineringsresponse-format

När du hämtar listor av resurser returnerar API:et ett paginerat svar med följande struktur:

{
  "_items": [
    {
      "_id": "resource_id_1",
      "name": "Resource Name 1"
      // ... other resource fields
    },
    {
      "_id": "resource_id_2",
      "name": "Resource Name 2"
      // ... other resource fields
    }
  ],
  "_meta": {
    "total": 150,
    "max_results": 25,
    "page": 1
  }
}

Response-fält:

• _items: Array av resursobjekt
• _meta.total: Totalt antal tillgängliga resurser
• _meta.max_results: Maximalt antal resultat per sida
• _meta.page: Nuvarande sidnummer

Query-parametrar

GET endpoints stöder följande query-parametrar för filtrering, sortering och paginering:

Pagineringsparametrar

• page: Sidnummer (standard: 1)
• max_results: Antal resultat per sida (standard: 25, max: 100)

Filtreringsparametrar

• where: JSON-filteruttryck för att filtrera resultat
• projection: JSON-projektion för att specificera vilka fält som ska inkluderas/exkluderas

Sorteringsparametrar

• sort: Fältnamn att sortera efter (prefix med - för fallande ordning)

Exempel Query

GET /creditors?page=2&max_results=10&where={"status":"active"}&sort=name

Detta skulle returnera:

• Sida 2 av resultat
• 10 resultat per sida
• Endast aktiva Creditors
• Sorterade efter namn i stigande ordning