DKA JSON API

v0

Ez a verzió nem tartalmazza a dokumentumok minden tulajdonságát és nem garantált a működése.

/api/v0/documents/:id

Egy dokumentum és a hozzá kapcsolódó tulajdonságok.

Pl.: /api/v0/documents/1

/api/v0/documents

Dokumentumok. Szűréshez használható URL paraméterek:

• limit: A visszaküldött dokumentumok száma.
  Alapértelmezett: limit=10.
  Pl.: /api/v0/documents?limit=2
• offset: Ettől a találattól kezdve érkeznek vissza a dokumentumok.
  Alapértelmezett: offset=0.
  Pl.: /api/v0/documents?offset=102
• page: Oldalszám. Felülírja az offset paramétert, a limit paramétert semmissé teszi.
  Alapértelmezett dokumentumok száma oldalanként: 10.
  Pl.: /api/v0/documents?page=3
• pagesize: A visszaküldött dokumentumok száma oldalanként. Csak a page paraméterrel együtt érvényes.
  Alapértelmezett: pagesize=10.
  Pl.: /api/v0/documents?page=3&pagesize=20
• orderby: A visszaküldött dokumentumok sorrendjének kialakításakor figyelembe vett tulajdonság.
  Elfogadott értékek: id, title.
  Alapértelmezett: orderby=id.
  Pl.: /api/v0/documents?orderby=title
• order: A visszaküldött dokumentumok sorrendje.
  Elfogadott értékek: desc (csökkenő), asc (növekvő).
  Alapértelmezett: order=asc.
  Pl.: /api/v0/documents?order=desc

/api/v0/:relation

Több dokumentumokhoz tartozó közös tulajdonságok listája

Elfogadott értékek:

• coverages
• contributors
• subcollections
• subtopics
• topics
• types

Szűréshez használható URL paraméterek:

• limit: A visszaküldött relációk száma.
  Alapértelmezett: limit=10.
  Pl.: /api/v0/coverages?limit=2
• offset: Ettől a találattól kezdve érkeznek vissza a relációk.
  Alapértelmezett: offset=0.
  Pl.: /api/v0/contributors=12
• page: Oldalszám. Felülírja az offset paramétert, a limit paramétert semmissé teszi.
  Alapértelmezett relációk száma oldalanként: 10.
  Pl.: /api/v0/types?page=3
• pagesize: A visszaküldött relációk száma oldalanként. Csak a page paraméterrel együtt érvényes.
  Alapértelmezett: pagesize=10.
  Pl.: /api/v0/subtopics?page=3&pagesize=5
• orderby: A visszaküldött relációk sorrendjének kialakításakor figyelembe vett tulajdonság.
  Elfogadott értékek: id, name.
  Alapértelmezett: orderby=id.
  Pl.: /api/v0/topics?orderby=name
• order: A visszaküldött relációk sorrendje.
  Elfogadott értékek: desc (csökkenő), asc (növekvő).
  Alapértelmezett: order=asc.
  Pl.: /api/v0/coverages?order=desc

/api/v0/:relation/:id

Több dokumentumokhoz tartozó közös tulajdonság.

/api/v0/:relation/:id/documents

Egy relációhoz tartozó dokumentumok.

Szűréshez használható paraméterek lásd: /api/v0/documents