request - Author API

Request Object

The request object contains all of configuration properties of authoring items and Activities as well as user identification.


= mandatory property

  • config object

    Configure options relating to the authoring experience and behavior of Author API.

  • mode string

    Start Author API in one of the four main user interface views for managing Items and Activities.

  • organisation_id number

    Specifies which Item bank to load Activity and Item content from.

  • reference string boolean

    Applies in item_edit and activity_edit modes only, denotes the reference of the Item or Activity you are creating/editing.

  • user object

    The current user's (author's) details.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.