API Documentation for the Admin Dashboard

• GET /examples

GET /examples #

Retrieve a collection of example entries.

Required Parameters #

• author_id (Integer) - Identifier of an author
• title (String) - Title of the book

Optional Parameters #

• highlight (Boolean) - Show only highlighted examples.

JSON Response Fields #

• examples (Array) - The collection of examples.
• examples[].id (Integer) - The id of that example.
• examples[].title (String) - The title of that example.
• examples[].text (String) - The text of that example.
• examples[].highlight (String) - Information if the example is highlighted.

Example Response #

{
  "examples": [{
    "id":1,
    "title":"Animals",
    "text":"Dogs and cats are some.",
    "highlight":true
  }]
}