Represents a piece of content in the system.

Usage

The LmsItemObject is used to create, modify, or search for content in the system. A populated LmsItemObject instance is passed in the array argument of a CreateOrUpdate call to create/update the item in Firmwater LMS.

Permissions

A logged in client application must ensure they have sufficient privilege and access rights to create or modify an item. The object to be saved is restricted by the following rules:

• the item's licensee must be accessible by the client application

Identifying Fields

Id

A 36-character globally unique identifier to uniquely identify an item. This field is read-only but can be used when searching for or updating an LmsItemObject.

Fields

LicenseeId

A string representing the ID of the licensee that the item is part of. An authenticated client application attempting to create/modify/access an item must have access to the licensee specified by LicenseeId.

ExternalItemId

A string used as an external identifier for the item. External identifiers are client specific. Firmwater LMS makes no assumption nor places restrictions on the significance of this string. External item identifiers are restricted to a maximum length of 100 characters.

ItemType

An ItemType object representing the item's type.

Title

A string representing the title of the item. Titles can be represented in multiple languages by specifying the 'xml:lang' attribute. Titles are restricted to a maximum length of 1000 characters. When searching for Items using the Title attribute there is no way to restrict the search based on language and the search is performed on all languages.

Keywords

A string representing common keywords or phrases that describe the item. Keywords can be represented in multiple languages by specifying the 'xml:lang' attribute. Multiple keywords that are defined for a language should be concatenated into a single string. Keyword strings for a language are restricted to a maximum length of 1000 characters. When searching for Items using the Keywords attribute there is no way to restrict the search based on language and the search is performed on all languages.

Coverage

A string representing that describes the time, culture, geography or region to which the item applies in the specified language. Coverage can be represented in multiple languages by specifying the 'xml:lang' attribute. Coverage for a language is restricted to a maximum length of 1000 characters. When searching for Items using the Coverage attribute there is no way to restrict the search based the on language and the search is performed on all languages.

Description

A string representing the description of the item. Descriptions can be represented in multiple languages by specifying the 'xml:lang' attribute. Descriptions are restricted to a maximum length of 1000 characters. When searching for Items using the Description attribute there is no way to restrict the search based on language and the search is performed on all languages. NOTE: When searching the only comparison operator supported by this attribute is 'like', all other operators will result in a search error.

IsActivity

A read-only boolean value representing whether this item is an activity or not.

IsEvent

A read-only boolean value representing whether this item is an event or not.

IsLeafItem

A read-only boolean value representing whether this item is a leaf item or not.

Event

An Event object representing the offline course information for this item. This property will only exist if the IsEvent property is true. When updating a LmsItemObject specifing an Event property will create an event for the item that is being modified if an event does not already exist, otherwise the existing event will be modified.

Activity

An Activity object representing the information about the activity (an activity is a top-level content within the LMS). This property will only exist if the IsActivity property is set to true. NOTE: When updating LmsItemObjects it is not possible to create activity information, it is only possible to update items that already contain activity information.

LeafItem

A LmsLeafItem object containing the information unique to leaf items (a leaf item is a bottom-level launchable item). This property will only exist if the IsLeafItem property is set to true. When updating a LmsItemObject, specifying the LeafItem property will create a new leaf item for the item that is being modified if it does not currently exist, otherwise the existing information will be modified.

ItemPrices

An array of ItemPrice objects representing any pricing information available about this item.

ItemOptions

An array of ItemOption objects representing any options associated with this item. ItemOptions are typically used with activities that are events (ex. event tickets, rides, hard-copy manuals, etc.)