API Endpoints

The laravel backend API server provides unified, module-generic access points organized by data/action requested.

The server expects, authenticates and validates the different requests whose defintions can be found here.
Endpoints loosely follow the the CRUD standard, with the addition of the init() and page():

• model/init() returns the module-specific three-tier (Categories/Groups/Option) data structure definitions to be stored on the frontend, in addition to some statistics, texts and other metadata.
• model/index() returns a collection of item ids according to the given filter parameters. This collection is referred to as “main” in the frontend.
• model/page() receives a list of ids (a subarray of one of the frontend collections) and returns more detailed data for those id referenced items according to a specific “view” (e.g. if the collection view is “Gallery” the returned json will include urls to the item’s media along with a short description). The paging system limits the amount of data loaded to the frontend.
• item.show() returns an item with its specific data, related media, and relations.
• carousel() returns details of an item sufficient to display it in a carousel form. Items can originate from either the "main" collection or the item's "media" or "related" collections.