Submit a request
Submit a request

Using Multiple Item Bank Sources in the Author API

This article outlines how to initialise the Author API with content from different Learnosity hosted Item banks.
 

By default, the Author API will source Items from the requesting clients' default Item bank.

However, if the requesting client wishes to load Items from a different Item bank, they can do so by overriding the organisation_id in the initialisation object.

Clients must first contact Learnosity to set up access to an additional Item bank / organisation. Once this has been set up, Learnosity will provide an organisation_id to use. Access to this secondary Item bank can be read only or read/write.

Sample code:

/*
|---------------------------------------------------------
| Set up access to a different item bank for use Author API.
|---------------------------------------------------------
|
| Specify an `organisation_id` at the root level of config object.
|
| Clients must liaise with Learnosity to set up this access.
|
*/

activity_edit{
  item_search{
item_banks{
{
organization_id:'1',
item_bank_name:'Math Content',
},
{
organization_id:'12',
item_pool_id:'Spring_Semester_CC_Math',
item_bank_name:'Spring Semester CC Math'
}
}
}
}

You can also configure Author API to use items from different item banks or item pools to add within a single assessment.

The array of item_banks in activity_edit.item_search allows you to show all Items from specified Item banks or Item pools when adding Items to an activity. Each entry in the item_banks array is an object with 2 required and 2 optional attributes. The required attributes are item_bank_name and organisation_id, the optional attributes are item_pool_id and filter.

The attribute item_bank_name specifies the display name of Item bank or Item pool in Author API which can be chosen freely.

The attribute organisation_id must be the integer id of an organisation to which the current user has access, it is your responsibility to correctly specify the organisation_id. If the user has no access to given organisation_id, an error message will be displayed when trying to access the Item bank.

The attribute item_pool_id allows you to access Item Pools. On initialisation, Author API does not check if an Item pool with a given item_pool_id exists, so if the item_pool_id is erroneous, an empty Item list will be displayed.

The attribute filter allows you to define a specific filter which is applied to the current Item bank. The definition of this filter is the same as that of the item_search.filter. If you specify item_search.filter with no Item bank specific filter, the item_search.filter will be applied to all of the Item banks.

The Item banks specified in the item_banks array are displayed in the same order as they appear in the configuration. The only exception to this rule is the default Item bank. The default Item bank is the Item bank of the organisation which Author API is initialised (i.e. it is the same Item bank which is used for displaying the list of available Items). If default Item bank is not specified in item_banks array, it is added automatically to the top of Item bank or Item pool entries in Author API as Default Item bank.

This multiple Item bank feature is incredibly useful for;

  1. Learnosity customers who use their own Item bank for content, but then also use an Item bank from one of our partners for content too.
  2. Learnosity customers with fragmented Item banks, who may use more than one Item bank for different projects, or teacher authoring, for example.
  3. Learnosity’s Item bank partners, who may themselves have multiple Item banks set up for easier content segregation.
  4. Teacher authors, who want to easily create an assessment, using the Activity Editor, with content from various Item banks.
 
Sample Code
/*
|---------------------------------------------------------
| Set up access to multiple item banks for use within activities.
|---------------------------------------------------------
|
| Specify an `organisation_id` at the item_banks config object of the
| initialisation object.
|
| Clients must liaise with Learnosity to set up this access.
|
*/

activity_edit{
  item_search{
item_banks{
{
organization_id:'1',
item_bank_name:'Math Content',
},
{
organization_id:'12',
item_pool_id:'Spring_Semester_CC_Math',
item_bank_name:'Spring Semester CC Math'
}
}
}
}
Was this article helpful?
0 out of 0 found this helpful

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