LMS Legacy API (1.0.0)

Download OpenAPI specification:Download

The PeopleFluent LMS Legacy API documentation.

News

Resources for reading news articles

publicNews

Returns a feed of public news articles. That is, news articles that are configured to display on the log-in page.

Authentication: Not supported.

query Parameters

format required	string Enum: "rssteasers" "rssfull" "atom" `rssteasers` for RSS 2.0 with teasers, `rssfull` for RSS 2.0 with full text, or `atom` for Atom 1.0.
categoryId	string Optional. If specified, only articles in the corresponding category are returned.

Responses

userNews

Returns a feed of news articles for a user.

Authentication: User Authentication (required).

query Parameters

format required	string Enum: "rssteasers" "rssfull" "atom" `rssteasers` for RSS 2.0 with teasers, `rssfull` for RSS 2.0 with full text, or `atom` for Atom 1.0.
categoryId	string Optional. If specified, only articles in the corresponding category are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

article

Returns an article as an Atom 1.0 entry.

Authentication: Not supported.

query Parameters

id

required

string

The ID of an article.

Responses

articles

Returns information about news articles.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format: `json` or `xml`.
keywords	string Search keywords.
publishedAfter	string <date-time> Only articles entered after this date are returned (HTML5/ISO format, e.g., `2009-11-13T20:00Z`).
publishedBefore	string <date-time> Only articles entered before this date are returned (HTML5/ISO format, e.g., `2009-11-13T20:00Z`).
categoryId	string If specified, only articles in the corresponding category are returned.
includeExpired	boolean Expired articles are excluded from the results unless this is set.
max	integer Default: 25 The maximum number of articles to return. If unspecified, all matching articles are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Learning Record and Enrollment Actions

Resources for managing learning records and enrollment actions

enrollments

Returns the active (incomplete) enrollments for a user.

Authentication: User Authentication (required).

query Parameters

assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

programModuleEnroller

Adds a module session enrollment to a program session enrollment.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

programSessionEnrollmentId required	string The program session enrollment ID.
moduleId required	string The module ID.
moduleSessionId	string The module session ID. At least one of `moduleSessionId` or `moduleSessionCode` must be specified.
moduleSessionCode	string The module session code. At least one of `moduleSessionId` or `moduleSessionCode` must be specified.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

records

Returns the training records for a user.

Authentication: User Authentication (required).

query Parameters

assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

record

Returns a training record.

Authentication: User Authentication (required).

query Parameters

id required	string The identifier for a training record.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

externalTrainingRequests

Returns external training requests pending for approval.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

externalTrainingRecords

Returns external training records.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

externalTrainingRecord

Returns an external training record.

Authentication: User Authentication (required).

query Parameters

id required	string The ID of the external training record.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

externalRecordAdder

Adds an external training record.

Authentication: User Authentication (required).

Request Body schema: multipart/form-data
required

title required	string The title (mandatory).
type	string Default: "learningProgram" The course type code.
subject	string The subject ID.
startDate required	string <date> The start date as an HTML5 date (mandatory).
endDate required	string <date> The end date as an HTML5 date (mandatory).
venue	string The venue.
language required	string Default: "en" The language code.
durationAmount	number The duration amount (numeric).
durationUnit required	string Default: "minute" Enum: "hour" "day" "week" "month" "year" One of `hour`, `day`, `week`, `month`, `year`.
costAmount	number The cost amount (numeric).
costCurrency required	string Default: "AED" The cost currency code (e.g. USD, HKD).
grade	string The grade.
score	string The score.
vendor	string Vendor information.
comments	string Comments.
attachment	string <binary> The attachment (file).
status required	string Default: "openForEditing" Enum: "openForEditing" "pendingApproval" "completed" "cancelled" One of `openForEditing`, `pendingApproval`, `completed`, `cancelled`.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

externalRecordUpdater

Updates an external training record.

Authentication: User Authentication (required).

Request Body schema: multipart/form-data
required

id required	string The ID of the external training record.
title required	string The title (mandatory).
type	string Default: "learningProgram" The course type code.
subject	string The subject ID.
startDate required	string <date> The start date as an HTML5 date (mandatory).
endDate required	string <date> The end date as an HTML5 date (mandatory).
venue	string The venue.
language required	string Default: "en" The language code.
durationAmount	number The duration amount (numeric).
durationUnit required	string Default: "minute" Enum: "hour" "day" "week" "month" "year" One of `hour`, `day`, `week`, `month`, `year`.
costAmount	number The cost amount (numeric).
costCurrency required	string Default: "AED" The cost currency code (e.g. USD, HKD).
grade	string The grade.
score	string The score.
vendor	string Vendor information.
comments	string Comments.
attachment	string <binary> The attachment (file).
status required	string Default: "openForEditing" Enum: "openForEditing" "pendingApproval" "completed" "cancelled" One of `openForEditing`, `pendingApproval`, `completed`, `cancelled`.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

externalRecordDeleter

Deletes an external training record.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

id required	string The ID of the external training record.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

learningPath

Returns the learning path for a user.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

enrollUser

Enroll a user into a learning module/program. If successful, it returns the corresponding enrollment. Otherwise, it returns error code/message.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

learning-id required	string The ID of the learning module/program to enroll into.
session-code	string The code (or ID) of the specific session within the learning module/program to enroll into.
reason	string Reason for enrolling.
preferredLocation	string Preferred location.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

enrollmentRequests

Returns enrollment requests for a specific user.

Authentication: User Authentication (required).

query Parameters

inbox	boolean `true` to return only requests that are awaiting a response from the user; otherwise, returns all requests regardless of status.
since	string <date-time> If specified, only requests submitted after this date will be returned.
filter	string Filter text.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

enrollmentRequestApprover

Approves an enrollment request. Possible status values for the response are: ok, waitlisted, not-successful, inactive-step, invalid-approver, no-such-request, no-such-step, payment-required.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

request-id required	string Identifier of the enrollment request to be approved.
step-id required	string Identifier of the step in the approval process for which the approval is to be issued.
comments	string Additional comments to be passed to the next approver.
cost-center	string Charged cost center.
email	string E-mail address to which notification will be sent.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

enrollmentRequestDenier

Denies an enrollment request. Possible status values for the response are: ok, waitlisted, not-successful, inactive-step, invalid-approver, no-such-request, no-such-step, payment-required.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

request-id required	string Identifier of the enrollment request to be denied.
step-id required	string Identifier of the step in the approval process for which the denial is to be issued.
comments	string Additional comments to be returned to the requester.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

taskApproval

Retrieve all task approvals.

Authentication: User Authentication (required).

query Parameters

status required	string Default: "all" Enum: "all" "pending" "approved" `all` to return both pending and approved requests, `pending` to return pending requests only, `approved` to return approved requests only.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

taskApprover

Submit task approval.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

taskId required	string Identifier for the task (enrollment).
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

contentPackage

Returns a content package, typically for offline use. The user on whose behalf the content package is being returned must be enrolled in the corresponding course revision, and the revision must permit downloads.

Authentication: User Authentication (required).

query Parameters

enrollmentId required	string The identifier for an enrollment, which must belong to the user on whose behalf the content package is being returned.
pdfToHtml	boolean If true and the package contains a single PDF document, the document will be rendered as HTML.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

launchTracker

Records a course launch in the context of an enrollment, which must belong to the user on whose behalf the launch is being recorded. The enrolled course revision must permit downloads.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

enrollmentId required	string The identifier for an enrollment, which must belong to the user on whose behalf the launch is being recorded.
datetime required	string <date-time> The date and time of the course launch.
allowNewAttempt	boolean Allowing the course to create new attempts if a previous attempt has been completed.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

hacpInfo

Returns information that can be used to communicate on behalf of a content item using the HTTP CMI AICC Protocol (HACP). The user on whose behalf the HACP information is being returned must be enrolled in the corresponding course revision, and the revision must permit downloads. In this context, a content item refers to a SCO or asset in a SCORM content package, or an assignable unit in an AICC course package.

Currently, the session IDs returned by this function do not expire. However, this behavior is subject to change and should not be relied upon. We recommend calling this function to obtain a current session ID immediately before initiating HACP communication.

Authentication: User Authentication (required).

query Parameters

enrollmentId required	string The identifier for an enrollment, which must belong to the user on whose behalf the HACP information is being returned.
itemId required	string The identifier for an item in the enrolled course revision. For a SCORM course, this corresponds with the `identifier` attribute of an `item` element in `imsmanifest.xml`. For an AICC course, it corresponds with the ID of an assignable unit as specified in the `.au` file.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

overallStatusChanger

Updates the overall status of an enrollment.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

enrollmentId required	string The identifier of the enrollment for which the status is to be updated.
status required	string Default: "unknown" The new status.
simpleResponse	boolean `true` to return only the affected enrollment; otherwise, returns all visible enrollments of the affected module.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

trainingHistoryXml

Returns training records for the specified user (or for all users if user ID is not specified) in XML format.

Authentication: System authentication.

Response schema: trainingHistory200510.xsd

query Parameters

userId	string Specifies the user whose training records will be returned.
organizationId	string Specify the organization ID of the users whose training records will be returned. Includes users belonging to descendant organizations.
lastUpdatedStart	string Start date filter applied to the last updated date. Returns records added or updated on or after this date. Format: `yyyy-MM-dd'T'HH:mm'Z'`.
lastUpdatedEnd	string End date filter applied to the last updated date. Returns records added or updated on or before this date. Format: `yyyy-MM-dd'T'HH:mm'Z'`.
moduleIds	string Comma-separated list of IDs of modules for which to return records, or empty.
includeOlder	boolean If true, all records will be returned for each module/assignment combination, rather than just the latest.
fields	string Field selector, e.g. `field1(child1,child2),field2`.

Responses

completedTrainingRecordsXml

Returns training records for completed courses for the specified user (or for all users if user ID is not specified) in XML format.

Authentication: System authentication.

Response schema: trainingHistory200510.xsd

query Parameters

userId	string Specifies the user whose training records will be returned.
organizationId	string Specify the organization ID of the users whose training records will be returned. Includes users belonging to descendant organizations.
lastUpdatedStart	string Start date filter applied to the last updated date. Returns records added or updated on or after this date. Format: `yyyy-MM-dd'T'HH:mm'Z'`.
lastUpdatedEnd	string End date filter applied to the last updated date. Returns records added or updated on or before this date. Format: `yyyy-MM-dd'T'HH:mm'Z'`.
moduleIds	string Comma-separated list of IDs of modules for which to return records, or empty.
includeOlder	boolean If true, all records will be returned for each module/assignment combination, rather than just the latest.
fields	string Field selector, e.g. `field1(child1,child2),field2`.

Responses

supervisorAssessments

Returns a list of supervisor assessments.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

supervisorAssessment

Returns the supervisor assessment assigned to an On-The-Job Training course.

Authentication: User Authentication (required).

query Parameters

id required	string The identifier for the enrollment for which the supervisor assessment is to be performed.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

withdrawalRequests

Returns withdrawal requests for a specific user.

Authentication: User Authentication (required).

query Parameters

inbox	boolean `true` to return only requests that are awaiting a response from the user; otherwise, returns all requests regardless of status.
since	string <date-time> If specified, only requests submitted after this date will be returned.
filter	string Filter text.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

withdrawalRequestApprover

Approves a withdrawal request.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

request-id required	string ID of the transcript to which a pending withdrawal request is associated.
comments	string Additional comments.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

withdrawalRequestDenier

Denies a withdrawal request.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

request-id required	string ID of the transcript to which a pending withdrawal request is associated.
comments	string Additional comments.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

participantSubstituter

Substitutes a participant in a session with another user (assignment). If targetAssignmentId is specified then targetUserId is not required. If targetUserId is specified then targetAssignmentId is required only if the user has more than one assignment. If both are specified they must be consistent (i.e. the specified assignment must belong to the specified user).

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

enrollmentId required	string The identifier of the enrollment that is to be substituted.
targetUserId	string The display ID (login name) of the user to be substituted. May be empty if `targetAssignmentId` is provided.
targetAssignmentId	string The display ID of the assignment to be substituted. May be empty if `targetUserId` is provided and the user has exactly one assignment.
notifications	boolean Email notifications will be sent if and only if this is `true`.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

contentHandler/trainingHistoryCsv

This simple comma-delimited text (CSV) format allows training records to be added and modified. It can also be used to enroll users in existing courses.

Authentication: System authentication.

CSV Fields:

Field	Content	Data Handling	Default
USERID	User ID	If blank, a classroom and session will be created with no associated training record.	None
LEARNINGID	Learning ID	A classroom and session will be created even if there is no USERID tagged to this code.	None
LOTITLE	Learning Module Title	A classroom and session will be created even if there is no USERID tagged to this name.	None
ENROLLDATE	Enrollment Date	Supported formats: `dd-mm-yy HH:MM`, `dd-mm-yyyy HH:MM`, `dd-mmm-yy HH:MM`, `dd-mmm-yyyy HH:MM`. Time defaults to `00:00` if omitted. Use `NONE` for no date.	If not specified, takes the start date. If start date is not specified or is future, takes today's date.
STARTDATE	Transcript Detail Start Date	Same date formats as ENROLLDATE. Use `NONE` for no date.	None
ENDDATE	Transcript Detail End Date	Same date formats as ENROLLDATE. Use `NONE` for no date.	None
STUDENTSTATUS	Transcript Overall Status	`Pass` → PASSED; `Completed` → COMPLETED; `Active` → enrolls user (IN PROGRESS if valid dates exist, NOT STARTED if no dates); `Withdrawn` → WITHDRAWN; `Deactivated` → DEACTIVATED; `EXEMPT` → WAIVER/EXEMPT.	None
CREATESESSION	Whether to create session	`true` creates a new session; `false` updates existing sessions. Applies to Classroom, Virtual Classroom, and Workshop/Seminar types only. When no sessions exist, a new session is always created regardless of this value.	False
Training Venue	Facility Code of the Session/Event	If code does not exist, it will not be set. Used only when creating a new session.	None
Instructor	Instructors of Learning Module	Must be a valid User ID. Separate multiple instructors with vertical bars, e.g. `instr1\|instr2\|instr3`. Used only when creating a new session.	None
SESSIONSTATUS	Learning Module Event Status	Possible values: `Active`, `Completed`, `Cancelled`. Used only when creating a new session.	Completed
SESSIONCODE	Session Code	When updating, identifies a specific session in a multi-session course. When creating, the session takes this value; if not specified, a code is generated per System Configuration.	None
SESSIONTITLE	Session Title	Used when creating a new session or updating session start/end dates. Available on PeopleFluent LMS 6.0.0.90 or above.	None
SCORE	Assessment Score	Applicable to classroom courses only. Online course data will not receive a score record.	None
LOTYPE	Learning Type	`C` Program, `M` Exam, `O` Online, `R` Classroom, `W` Workshop/Seminar, `1` Self Training (Paper), `2` Self Training (Video), `3` Special Interest Group, `4` Coaching. Effective only if skip enrollment check is enabled.	None
ACTION	Action	`A` adds a record if none exists; `U` updates an existing record; blank adds or updates. Not effective if skip enrollment check is enabled.	None
PRESCORE	Pre-Assessment Score	Numeric field.	None
POSTSCORE	Post-Assessment Score	Numeric field.	None
LANGUAGE	Language	Language name or ISO 2-char code (e.g., `en`, `fr_CA`, `es_ES`). Applicable when inserting a new transcript or creating a new session. Max 50 characters.	Primary language
USE SETTINGS AS OF DATE	Use settings/data as of that date for certification	Supported formats: `dd-mm-yy`, `dd-mm-yyyy`, `dd-mmm-yy`, `dd-mmm-yyyy`. Requires CFR license.	None
SESSIONTIMEZONE	Session Level Time Zone	Time zone ID.	System Time Zone for new sessions; session's original timezone for existing sessions.
DEADLINEDAYS	Completion Deadline (Days)	Days from enrollment. 0 implies unlimited.	None
DEADLINEDATE	Completion Deadline (Date)	Formats: `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd`.	None
Parent Program ID	Learning ID of the parent program	Applicable for new enrollments only. Learner must already be enrolled on the program. Ignored when updating a transcript or if skip enrollment check is enabled.	None
Transfer Session Code	Code of session to transfer learner to	Only applicable when updating an existing enrollment. Ignored if skip enrollment check is enabled.	None
Performance Grade	Performance Grade ID	`1` Excellent, `2` Very Good, `3` Good, `4` Average, `5` Poor. Use `NONE` to clear.	None

Request Body schema: text/plain
required

string

CSV-formatted training record data.

Responses

contentHandler/externalTrainingCsv

This simple comma-delimited text (CSV) format allows external training records to be added, modified, and deleted.

Authentication: System authentication.

CSV Fields:

Field	Content	Data Handling	Default
Action	Control Action	Must be `A` (Add), `D` (Delete), `U` (Update), or `AU` (Add or Update as appropriate).	None
RecordID	Record ID	A unique ID conforming to PeopleFluent LMS ID constraints. Max 15 characters.	None
UserId	PeopleFluent LMS User ID	A unique ID conforming to PeopleFluent LMS ID constraints. Max 85 characters.	None
Title	Title	Any text. Max 255 characters.	None
CourseType	Learning Type	`TNS` (not specified), `C` Program, `R` Classroom, `O` Online, `W` Workshop/Seminar. Max 1 character.	None
StartDate	Start Date	Formats: `yyyy-MM-dd HH:mm:ss` (e.g. `2010-08-25 13:00:00`) or `yyyy-MM-dd` (e.g. `2012-06-17`).	None
EndDate	End Date	Formats: `yyyy-MM-dd HH:mm:ss` (e.g. `2010-08-25 13:00:00`) or `yyyy-MM-dd` (e.g. `2012-06-17`).	None
Status	Status	`0` Open for editing, `1` Pending Approval, `2` Approved, `3` Approval Denied, `4` Completed, `5` Cancelled.	OPEN_FOR_EDITING
Subject	Subject	Name of a predefined course subject. Any text. Max 50 characters.	None
Grade	Grade	Any text.	None
Score	Score	Any text.	None
Duration	Duration	A decimal value with up to two decimal places, e.g., `12.50` or `5.25`.	0
Unit	Duration Unit	`I` Minute(s), `H` Hour(s), `D` Day(s), `W` Week(s), `M` Month(s), `Y` Year(s).	None
Cost	Course Cost	A monetary value with up to two decimal places, e.g., `250` or `350.55`.	None
Currency	Module Charge Currency	A three-letter currency code, e.g., `GBP` or `USD`.	None
Language	Language	ISO 2-char code, e.g., `en`, `fr_CA`, `es_ES`.	None
VendorInfo1	Vendor Information	Any text.	None
Comments	Comments	Any text.	None

Request Body schema: text/plain
required

string

CSV-formatted external training record data.

Responses

Learning Module Actions

Resources for browsing and managing learning modules and content

catalog

Returns information about a catalog in XML format. Includes information about the catalog's parent and children and the modules it contains.

Authentication: User Authentication (supported).

query Parameters

id required	string Default: "ROOT" Specifies the ID of the catalog to return (`ROOT` for the top-level catalog).
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

module

Returns information about a program or module in XML format. Includes information about the module or program's sessions, if any.

Authentication: User Authentication (supported).

query Parameters

id required	string Specifies the ID of the module to return.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

modules

Returns summary information about modules matching the specified criteria.

Authentication: User Authentication (supported).

query Parameters

sort required	string Default: "relevance" Enum: "relevance" "created" `relevance` to return results according to how closely they match the search criteria; `created` to return results according to the date they were created, most recent first.
format required	string Default: "xml" Enum: "xml" "rss" "atom" The response format: `xml`, `rss`, or `atom`.
keywords	string Keywords that must be present in the module's catalog entry. If unspecified, results are not filtered by keyword.
sessionOnOrAfter	string <date> The date on or after which matching sessions are scheduled, or empty.
sessionBefore	string <date> The date before which matching sessions are scheduled, or empty.
max	integer Default: 25 The maximum number of matching modules to return. If unspecified, all matching modules are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

preloadModules

Loads API modules into cache.

Authentication: User Authentication (supported).

query Parameters

onBehalfOf

string

The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

facility

Returns information about a facility.

Authentication: User Authentication (required).

query Parameters

id required	string The ID of the facility to return.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

resources

Returns information about reference resources.

Authentication: User Authentication (supported).

query Parameters

format required	string Default: "json" Enum: "xml" "json" The response format: `xml` or `json`.
keywords	string Search keywords.
max	integer Default: 25 The maximum number of reference resources to return. If unspecified, all matching reference resources are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

resource

Returns a reference resource.

Authentication: User Authentication (supported).

query Parameters

url required	string The URL of the reference resource, as returned by the `resources` function.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

participants

Returns session participants.

Authentication: User Authentication (required).

query Parameters

moduleId required	string The module ID.
sessionId required	string The session ID.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

contentPackageImporter

Imports a SCORM or IMS content package.

Authentication: User Authentication (required).

Request Body schema: multipart/form-data
required

package required	string <binary> The content package file.
versioning required	string The versioning strategy to employ if there is already a package with the specified identifier. Unless a specific strategy is chosen, an already existing package will not be updated.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

contentHandler/courses

This XML format allows for the addition and modification of courses and sessions.

Authentication: System authentication.

Request schema: courses.xsd

Request Body schema: application/xml
required

string

XML-formatted course and session data conforming to courses.xsd.

Responses

Career Development Actions

Resources for managing competencies, job profiles, and career development

competencies

Returns information about competencies.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
keywords	string Search keywords.
max	integer Default: 25 The maximum number of competencies to return. If unspecified, all matching competencies are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

competency

Returns information about a competency.

Authentication: User Authentication (required).

query Parameters

id required	string The ID of the competency to return.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

jobProfiles

Returns available job profiles, organized by catalog.

Authentication: User Authentication (required).

query Parameters

groupBy required	string Default: "catalog" Enum: "catalog" "none" `catalog` or `none`. If unspecified, results are grouped by catalog.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
keywords	string Search keywords. If specified, results are returned in order of relevance.
max	integer Default: 25 The maximum number of job profiles to return. If unspecified, all matching job profiles are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

trainingPlan

Returns a user's training plan.

Authentication: User Authentication (required).

query Parameters

assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

assignedJobProfiles

Returns the job profiles assigned to a user.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

competencyCompletionStatus

Returns the completion status of competencies associated with a user.

Authentication: User Authentication (required).

query Parameters

assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

certificationsAwarded

Returns certifications awarded to a user.

Authentication: User Authentication (required).

query Parameters

assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

certificate

Returns a certificate in PDF format.

Authentication: User Authentication (required).

query Parameters

awardId required	string Identifier for the certificate to be returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

competenciesAwarded

Returns competencies awarded to a user.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

jobProfileAssigner

Assigns a job profile to a user.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

profileId required	string Identifier of the job profile to be assigned.
userId	string Identifier of the user to whom the job profile is to be assigned.
targetAssignmentId	string Assignment of the user to whom the job profile is to be assigned.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

jobProfileUnassigner

Removes a job profile from a user assignment.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

profileId required	string The ID of the job profile to be unassigned.
userId	string The ID of the user from whom the job profile is to be unassigned.
targetAssignmentId	string The ID of the user assignment from which the job profile is to be unassigned.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

userJobProfilePath

Returns a user's job profile path.

Authentication: User Authentication (required).

query Parameters

assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Community Actions

Resources for messaging and forum interactions

mailbox

Returns a user's messages.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

message

Returns the content of a message.

Authentication: User Authentication (required).

query Parameters

id required	string The message ID.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

messageUpdater

Marks a message as read.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

id required	string The message ID.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

latestForumPosts

Returns the most recent forum posts (topics and replies).

Authentication: User Authentication (required).

query Parameters

format required	string Default: "rss" Enum: "rss" "atom" `rss` for RSS 2.0, or `atom` for Atom 1.0.
max	integer Default: 25 The maximum number of posts to return. If unspecified, all posts are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

User Actions

Resources for managing users, assignments, and organizations

assignments

Returns the authenticating user's assignments.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

people

Returns information about people.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
keywords	string Search keywords.
id	string User ID.
first	string First name.
last	string Last name.
max	integer Default: 25 The maximum number of people to return. If unspecified, all matching people are returned.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

directReports

Returns a user's direct reports.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

me

Returns information about the authenticating user.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

recentActivity

Returns information about the authenticating user's classmates' recent activity.

Authentication: User Authentication (required).

query Parameters

activityType required	string Only activities matching this activity type are returned.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
userId	string Identifier of the user whose recent activities are returned.
startDate	string <date-time> Only activities after this date are returned (HTML5/ISO format, e.g., `2009-11-13T20:00Z`).
endDate	string <date-time> Only activities before this date are returned (HTML5/ISO format, e.g., `2009-11-13T20:00Z`).
max	integer Default: 20 The maximum number of recent activities to return. Defaults to 20.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

users

Returns information about user accounts.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
userId	string User ID, or empty.
organizationId	string Organization ID, or empty.
email	string Email address, or empty.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

organization

Returns information about an organization.

Authentication: User Authentication (required).

query Parameters

id required	string Default: "ROOT" The ID of the organization to return (`ROOT` for the top-level organization).
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
recursive	boolean If true, returns all descendant organizations rather than direct children only.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

userGroupCreator

Creates a user group.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

group-name required	string Name of the group to be created.
shared	boolean `true` to create a shared user group, visible to users within or below the highest-level organization visible to the creator; otherwise, the group will be visible only to the creator.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

userGroupDeleter

Deletes the specified group.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

group-name required	string Name of the group to be deleted.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

userGroupAdder

Adds the specified user to the specified group.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

group-name required	string Name of the group to which the user is to be added.
user-id	string Identifier of the user to be added to the group.
targetAssignmentId	string Assignment of the user to be added to the group.
targetAssignmentCode	string Assignment reference code of the user to be added to the group.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

userGroupRemover

Removes the specified user from the specified group.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

group-name required	string Name of the group from which the user is to be removed.
user-id	string Identifier of the user to be removed from the group.
targetAssignmentId	string Assignment of the user to be removed from the group.
targetAssignmentCode	string Assignment reference code of the user to be removed from the group.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

supervisedGroupsAdder

Adds the specified group to the specified user's supervised groups.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

group-name required	string Name of the group to be added to the user's supervised groups.
user-id	string Identifier of the user to whose supervised groups the group is to be added.
targetAssignmentId	string Assignment of the user to whose supervised groups the group is to be added.
targetAssignmentCode	string Assignment reference code of the user to whose supervised groups the group is to be added.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

supervisedGroupsRemover

Removes the specified group from the specified user's supervised groups.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

group-name required	string Name of the group to be removed from the user's supervised groups.
user-id	string Identifier of the user from whose supervised groups the group is to be removed.
targetAssignmentId	string Assignment of the user from whose supervised groups the group is to be removed.
targetAssignmentCode	string Assignment reference code of the user from whose supervised groups the group is to be removed.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

user200510Xml

Returns information about a single user in XML format.

Authentication: System authentication.

Response schema: users200510.xsd

query Parameters

userId required	string Specifies the user about whom information will be returned.
fields	string Field selector, e.g. `field1(child1,child2),field2`.

Responses

users200510Xml

Returns information about all users in XML format.

Authentication: System authentication.

Response schema: users200510.xsd

query Parameters

status required	string The status to filter by.
organizationId	string The ID of the organization to filter by.
fields	string Field selector, e.g. `field1(child1,child2),field2`.

Responses

Exam Actions

Resources for submitting and retrieving assessment attempts

assessmentAttemptHandler

Submission of assessment attempt.

Authentication: User Authentication (required).

Request Body schema: application/x-www-form-urlencoded
required

attempt required	string JSON text of the attempt descriptor.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

assessmentAttemptSummary

Returns a summary of an attempt at an assessment.

Authentication: User Authentication (required).

query Parameters

id required	string The ID of the attempt for which a summary is to be returned.
format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

Report Actions

Resources for accessing batch reports

batchReports

Returns a listing of batch reports.

Authentication: User Authentication (required).

query Parameters

format required	string Default: "json" Enum: "json" "xml" The response format, `json` or `xml`.
name	string The report name, or empty.
createdOnOrAfter	string <date-time> The date on or after which returned reports were created, or empty.
createdBefore	string <date-time> The date before which returned reports were created, or empty.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

Responses

Response samples

200

Content type

application/json

{ }

batchReport

Returns the content of a batch report.

Authentication: User Authentication (required).

query Parameters

pathname required	string The report pathname.
assignmentId	string The ID of the assignment in the context of which this call will be executed. May be empty if the authenticating user has only one assignment.
onBehalfOf	string The user id for whom the results will be returned. The onBehalfOf user must be visible to the authenticated user, and the authenticated user must have Switch User permissions.

LMS Legacy API (1.0.0)

News

publicNews

query Parameters

Responses

userNews

query Parameters

Responses

article

query Parameters

Responses

articles

query Parameters

Responses

Learning Record and Enrollment Actions

enrollments

query Parameters

Responses

programModuleEnroller

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

records

query Parameters

Responses

record

query Parameters

Responses

Response samples

externalTrainingRequests

query Parameters

Responses

Response samples

externalTrainingRecords

query Parameters

Responses

Response samples

externalTrainingRecord

query Parameters

Responses

Response samples

externalRecordAdder

Request Body schema: multipart/form-datarequired

Responses

Response samples

externalRecordUpdater

Request Body schema: multipart/form-datarequired

Responses

Response samples

externalRecordDeleter

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

learningPath

query Parameters

Responses

Response samples

enrollUser

Request Body schema: application/x-www-form-urlencodedrequired

Responses

enrollmentRequests

query Parameters

Responses

Response samples

enrollmentRequestApprover

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

enrollmentRequestDenier

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

taskApproval

query Parameters

Responses

Response samples

taskApprover

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: text/plain
required

Request Body schema: text/plain
required