LmsStatusObject

Usage

The LmsStatusObject is used to search and return results on the status of a top-level item for a person.

Permissions

A logged in client application must ensure they have sufficient privilege and access rights to search for the person's results. The following rules will apply to the search:

  • if client specifies a person in the search terms, the person's licensee must be accessible by the client application

Identifying Fields

To identify an LmsStatusObject, one field from each of the following two groups must be specified (A description of these fields follows below):

  • Person Identification:
    • PersonId
    • Username AND LicenseeId
  • Item Identification
    • ItemId
    • ExternalItemId AND LicenseeId

PersonId

A 36-character globally unique identifier to identify a person. This field is read-only.

Username

A string representing the person's username that will be used for Firmwater LMS logins. Usernames are unique within a licensee; therefore, a valid licensee ID and username will uniquely identify a person. This field is read-only.

LicenseeId

A string representing the ID of the licensee that the person is a part of. An authenticated client application attempting to search on a person item status must have access to the licensee specified by LicenseeId. This field is read-only.

ItemId

A 36-character globally unique identifier to identify an item. This field is read-only.

ExternalItemId

A string used as an external identifier for the item. External identifiers are client specific. This field is read-only.

Fields

ItemTitle

When searching using the Title attribute the search is based on the current person's language. Where the "current person" is the person that is logged into the web service and performing the search. This field is read-only.

ItemType

An ItemType object representing the item's type.

FirstActiveDatetime

Datetime value indicating the earliest date and time the person can access the item. This field is read-only.

LastActiveDatetime

Datetime value indicating the last date and time the person can access the item. If set to an empty string, there is no end date for the item. This field is read-only.

IsRegistrationEnabled

Boolean value representing if the registration operation is enabled and the operation is available within the date range and due dates specified. This field is read-only.

DueDatetime

If this item must be completed by a specific date and time, then this field will contain the deadline datetime value. If set to an empty string, there is no fixed deadline for the item.

PassingScore

Decimal value indicating the passing score for the item. If set to an empty string, there is no passing score.

AttemptLimit

Integer value representing the maximum number of attempts for the activity. If set to an empty string, the user has access to an unlimited number of attempts.

IsEvent

Boolean value representing whether this item is an event or not. This field is read-only.

Event

An Event object representing the offline course information for this item. This property will only exist if the IsEvent property is true.

ReportedStatus

An enumerated type representing the reported status of the item. Possible values are: notStarted, inProgress, incomplete, completed, failed, passed.

Duration

Integer value representing the total seconds the person interacted with the item.

StartedDatetime

Datetime value representing when the person first started the attempt on the item. If set to an empty string, the person has not started the item.

CompletedDatetime

Datetime value representing when the item was completed. If set to an empty string, the user has not completed the item.

ItemAttemptCount

Integer value representing the number of attempts at the item the person has had. This field is read-only.

ItemResults[]

Array of ItemResult objects if the person has completed attempts at any scored items within the item.

The following fields are deprecated:

CompletionStatus

String value representing the completion status of the item. Possible values: 'completed', 'incomplete', 'not attempted', 'unknown'.

SuccessStatus

String value representing the success status of the item. Possible values: 'passed', 'failed', 'unknown'.