LMS Legacy API (1.0.0)
Download OpenAPI specification:Download
The PeopleFluent LMS Legacy API documentation.
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"
|
| 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"
|
| 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
articles
Returns information about news articles.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format: |
| keywords | string Search keywords. |
| publishedAfter | string <date-time> Only articles entered after this date are returned (HTML5/ISO format, e.g., |
| publishedBefore | string <date-time> Only articles entered before this date are returned (HTML5/ISO format, e.g., |
| 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
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-urlencodedrequired
| programSessionEnrollmentId required | string The program session enrollment ID. |
| moduleId required | string The module ID. |
| moduleSessionId | string The module session ID. At least one of |
| moduleSessionCode | string The module session code. At least one of |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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
{ }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, |
| 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
{ }externalTrainingRecords
Returns external training records.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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
{ }externalRecordAdder
Adds an external training record.
Authentication: User Authentication (required).
Request Body schema: multipart/form-datarequired
| 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 |
| 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 |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }externalRecordUpdater
Updates an external training record.
Authentication: User Authentication (required).
Request Body schema: multipart/form-datarequired
| 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 |
| 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 |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }externalRecordDeleter
Deletes an external training record.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| id required | string The ID of the external training record. |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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
{ }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-urlencodedrequired
| 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
|
| 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, |
| 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
{ }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-urlencodedrequired
| 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. |
string E-mail address to which notification will be sent. | |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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-urlencodedrequired
| 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, |
| 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
{ }taskApproval
Retrieve all task approvals.
Authentication: User Authentication (required).
query Parameters
| status required | string Default: "all" Enum: "all" "pending" "approved"
|
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }taskApprover
Submit task approval.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| taskId required | string Identifier for the task (enrollment). |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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-urlencodedrequired
| 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, |
| 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
{ }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 |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }overallStatusChanger
Updates the overall status of an enrollment.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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
|
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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: |
| lastUpdatedEnd | string End date filter applied to the last updated date. Returns records added or updated on or before this date. Format: |
| 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. |
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: |
| lastUpdatedEnd | string End date filter applied to the last updated date. Returns records added or updated on or before this date. Format: |
| 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. |
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, |
| 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
{ }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
|
| 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, |
| 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
{ }withdrawalRequestApprover
Approves a withdrawal request.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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, |
| 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
{ }withdrawalRequestDenier
Denies a withdrawal request.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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, |
| 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
{ }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-urlencodedrequired
| 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 | string The display ID of the assignment to be substituted. May be empty if |
| notifications | boolean Email notifications will be sent if and only if this is |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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/plainrequired
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/plainrequired
CSV-formatted external training record data.
Responses
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 ( |
| 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"
|
| format required | string Default: "xml" Enum: "xml" "rss" "atom" The response format: |
| 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, |
| 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
{ }resources
Returns information about reference resources.
Authentication: User Authentication (supported).
query Parameters
| format required | string Default: "json" Enum: "xml" "json" The response format: |
| 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
{ }resource
Returns a reference resource.
Authentication: User Authentication (supported).
query Parameters
| url required | string The URL of the reference resource, as returned by the |
| 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, |
| 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
{ }contentPackageImporter
Imports a SCORM or IMS content package.
Authentication: User Authentication (required).
Request Body schema: multipart/form-datarequired
| 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, |
| 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
{ }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/xmlrequired
XML-formatted course and session data conforming to courses.xsd.
Responses
contentHandler/courseCsv
This simple comma-delimited text (CSV) format allows learning modules to be added, modified, and deleted. The learning module can be at course level, session level, or class level.
For details, refer to the online help of the course CSV loader in Catalog Manager.
Authentication: System authentication.
Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
Adding new courses:
- The mandatory fields when adding are:
Action,ModuleID,ModuleLearningType.
Updating existing courses:
- Through the CSV loader, it is possible to update data at course level, session level, or class level.
- To update a specific class, the module ID, the session code, and the class start date must be specified. To update a specific session, only the module ID and the session code need to be specified. To update a course, only the module ID is required.
Deleting existing courses:
- Through the CSV loader, it is possible to delete an entire course, a specific session of a course, or a specific class of a session.
- To delete a specific class, the module ID, the session code, and the class start and end dates must be specified. To delete a specific session, only the module ID and the session code need to be specified. To delete a course, only the module ID is required.
CSV Fields:
| Field | Content | Data Handling | Default |
|---|---|---|---|
| Action | Control Action (Either Add, Delete or Update) | Must be A, D, U, or AU (Add, Delete, Update, Add or Update as appropriate) |
None |
| ModuleID | Module ID | A Unique ID That Conforms to PeopleFluent LMS ID constraints (maximum 85 characters) | None |
| ModuleLearningType | Learning Type | Must be one of: A Audio Cassette, B Book, D CD ROM, R Classroom, 4 Coaching, M Exam, X External Certification, E External Course, Q Just-In-Time Learning, O Online, J On-the-Job Training, 1 Self-Training (Paper), 2 Self-Training (Video), 3 Special Interest Group, T Task, I Video, V Virtual Classroom, U Virtual Classroom (Archived), W Workshop/Seminar (maximum 1 characters) |
None |
| ModuleTitle | Course Title | Any Text (Max field length:255) | no title |
| ModuleDescription | Course Description | Any Text (Max field length:None) | None |
| ModuleMoreInfoHyperlink | More Information Hyperlink | Any Text (Max field length:500) | None |
| ModuleDurationComments | Duration Comments | Any Text (Max field length:100) | None |
| ModuleSubject | Subject | Name of a Predefined Course Subject; Any Text (Max field length:50) | None |
| ModuleCategory | Category | Name of a Predefined Course Category; Any Text (Max field length:50) | None |
| ModuleImage | Image for Catalog Display | A valid URL for an image, e.g., http://www.abc.com/abc.png or /ekp/nd/fresco/repository/EKP0002343.jpg; Any Text (Max field length:500) | None |
| ModuleShowInCatalog | Show in catalog | Y or N |
N |
| ModuleArchive | Archive | Y or N |
N |
| ModuleArchiveDate | Auto-Archive Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) (*NONE* to clear) |
None |
| ModulePeerComments | Allow peer review/comments | Y or N |
Y |
| ModuleChargeType | Module Charge Procedure | Must be one of: NONE No charge., PER REG Charged per Registration, ONLINE Online Payment, NOT SUPPORTED Organization One Off Token Payment |
No charge. |
| ModuleCost | Course Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 | None |
| ModuleCurrency | Module Charge Currency | A three letter currency code, e.g., GBP or USD | None |
| ModulePriceInfo | Currency Cost Price Info | Any Text (Max field length:300) | None |
| ModuleCostCenter | Charged Cost Center | Any Text (Max field length:45) | None |
| ModuleTokenCost | Token Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 | None |
| ModuleTokenPriceInfo | Token Cost Price Info | Any Text (Max field length:300) | None |
| ModuleLanguage | Language | Name of a Predefined Course Language or ISO 2-char codes, e.g., en, fr_CA, es_ES; Any Text (Max field length:50) | Observe System Configuration setting Default Language For New Objects |
| ModuleVendor | Vendor | Name of a Predefined Course Vendor; Any Text (Max field length:255) | None |
| ModuleCertification | Certification Name | Name of a Predefined Certification; Any Text (Max field length:1,000) | None |
| ModuleExams | Exams | List of predefined exam IDs, delimited by vertical bars, e.g., EXAM1|EXAM2|EXAM3 | None |
| ModuleExamsMandatory | Exams are mandatory. | Y or N |
N |
| ModuleExamCompletesModule | Passing exam(s) automatically completes this module | N - No; Y - Any of the selected exams.; A - All of the selected exams. | N |
| ModuleEvaluation | Evaluation | Exam ID of Predefined Evaluation | None |
| SupervisorAssessment | Supervisor Assessment | Exam ID of Predefined Supervisor Assessment | None |
| ModuleCatalogs | Assign course to catalogs | A list of catalog names, each of which may be hierarchical, separated by a vertical bar, e.g., A/B/C1|A/B/C2 | None |
| ModuleAudience | Audience | List of descriptions delimited by vertical bars (|). Each description has a maximum length of 255. |
None |
| ModuleObjectives | Objectives | List of descriptions delimited by vertical bars (|). Each description has a maximum length of 2,000. |
None |
| ModuleAllowUserWithdraw | Allow user to WITHDRAW | Y or N |
Y |
| ModuleUserWithdrawReason | Prompt user for reason for the withdrawal | Y or N |
N |
| ModuleAllowUserComplete | Allow user to mark Completed (Self-Asserted) | Y or N |
Y |
| ModuleAllowStatusChange | Allow status changes to be made at any time (e.g., ignore standard business rules) | Y or N |
N |
| ModuleAllowReEnroll | Allow re-enrollment | Y or N |
Y |
| ModuleEnrollmentPolicy | Enrollment Policy | Name of a Predefined Enrollment Policy; Any Text (Max field length:50) | None |
| ModuleOrgPolicyFirst | Org policy overrides course policy. | Y or N |
N |
| ModuleKcEnable | Enable the Knowledge Center for this module | Y or N |
Y |
| ModuleKcShowPictureArea | (KC) AREA: Show picture area | Y, N or I (I, Knowledge Center show picture area configuration inherits from catalog setting) |
Y |
| ModuleKcPicture | KC Picture URL | A valid URL for an image, e.g., http://www.abc.com/abc.png or /ekp/nd/fresco/repository/EKP0002343.jpg; Any Text (Max field length:255) | None |
| ModuleKcAllowCourseLaunch | Allow module launches in KC | Y or N |
Y |
| ModuleKcCourseLink | Course link always launches the KC instead of the course. | Y or N |
N |
| ModuleKcAssessmentWorkflow | (KC) AREA: Show assessment workflow area | Y or N |
Y |
| ModuleKcCertification | (KC) AREA: Show certification area | Y or N |
Y |
| ModuleKcContactList | (KC) AREA: Show contact list area | Y or N |
Y |
| ModuleKcCourseSummary | (KC) AREA: Show course summary area | Y or N |
Y |
| ModuleKcEvaluation | (KC) AREA: Show evaluation area | Y or N |
Y |
| ModuleKcForum | (KC) AREA: Show forum area | Y or N |
Y |
| ModuleKcInstructorList | (KC) AREA: Show instructor list area | Y or N |
Y |
| ModuleKcNews | (KC) AREA: Show news area | Y or N |
Y |
| ModuleKcNotepad | (KC) AREA: Show notepad area | Y or N |
Y |
| ModuleKcPeerComments | (KC) AREA: Show peer comments area | Y or N |
Y |
| ModuleKcReferences | (KC) AREA: Show references area | Y or N |
Y |
| ModuleKcStatusChange | (KC) AREA: Show status change area | Y or N |
Y |
| ModuleKcExam | (KC) AREA: Show exam area | Y or N |
Y |
| ModuleKcInstructorAboutMe | (KC) AREA: Show About Me for the instructor | Y or N |
Y |
| ModuleKcInstructorReferences | (KC) AREA: Show reference share area for instructors | Y or N |
Y |
| ModuleKcFileShare | (KC) AREA: Show file share area | Y or N |
N |
| ModuleKcHomeworkDropBox | (KC) AREA: Show homework drop box | Y or N |
N |
| ModuleKcMarkedHomework | (KC) AREA: Show marked/reviewed homework | Y or N |
N |
| ModuleKcTranscript | (KC) AREA: Show transcript area | Y or N |
Y |
| ModuleKcQuickEvaluation | (KC) AREA: Show quick evaluation area | Y or N |
N |
| ModuleKcShowModuleAttributes | (KC) AREA: Show Module Attributes | Y or N |
Y |
| CreateWikiSpace | Create Wiki Space | Y or N |
N |
| WikiSpaceName | Wiki Space Name | Any Text (Max field length:None) | Course Title |
| ModuleEvalMandatory | Mandatory Evaluation | Y or N |
N |
| TemplateID | Template | Name of a Predefined Template (Updates only) | None |
| PermReplace | Permissions Action | Y - to completely replace permission settings on this course using permissions from the master template.; N - to add to existing permission settings on this course using permissions from the master template. |
N |
| PermTemplateID | Permissions Template | Learning object ID whose permissions are used as a master template for this course |
None |
| ModuleRequireESignatures | Require eSignatures | Y or N |
N |
| ModuleAllowReopen | To prevent a participant from reopening this module once it has been completed, use the setting below. | Y or N |
Y |
| ModuleAllowPublicAccess | This module/program currently allows public access. | Y or N |
Y |
| ModuleSupportContact | Course Support Contact | Any Text (Max field length:255) | None |
| Prereq_Lid | Prerequisites | List of module IDs delimited by vertical bars (|). The maximum length of the list is 255. |
None |
| Prereq_Check_Type | Prerequisite Check Type | NO_PREVIOUS, ENROLLED, CMI_COMPLETE, or COMPLETE. Only effective when used with PREREQ_LID list. | ENROLLED |
| Prereq_Logic | Prerequisite Check Type | AND, OR. Only effective when used with PREREQ_LID list. | AND |
| Prereq_Lid_Sec | Prerequisites | List of module IDs delimited by vertical bars (|). The maximum length of the list is 255. |
None |
| Prereq_Check_Type_Sec | Prerequisite Check Type | NO_PREVIOUS, ENROLLED, CMI_COMPLETE, or COMPLETE. Only effective when used with PREREQ_LID list. | ENROLLED |
| Prereq_Logic_Sec | Prerequisite Check Type | AND, OR. Only effective when used with PREREQ_LID list. | AND |
| ModuleAllowSelfEnrollment | Allow self-enrollment | Y or N; Applicable only for the following types: R Classroom, 4 Coaching, M Exam, O Online, J On-the-Job Training, 1 Self-Training (Paper), 2 Self-Training (Video), 3 Special Interest Group, T Task, V Virtual Classroom, U Virtual Classroom (Archived), W Workshop/Seminar |
Y |
| ModuleAllowSessionTransfer | Allow session transfer | Y or N |
N |
| AddUserToModuleReadPermissions | Add user(s) to learning module Read Permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
None |
| RemoveUserFromModuleReadPermissions | Remove user(s) from learning module read permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
None |
| AddUserToSessionReadPermissions | Add user(s) to learning module Read Permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
None |
| RemoveUserFromSessionReadPermissions | Remove user(s) from learning module read permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
None |
| SessionID | Session Code | Any Text (Max field length:85) | None |
| SessionTitle | Session Title | Any Text (Max field length:255) | None |
| SessionDescription | Session Description | Any Text (Max field length:None) (*NONE* to clear) |
None |
| SessionStatus | Session Status | Must be one of: active Active, pending Pending, completed Completed, closed Closed, cancelled Cancelled, invitation Invitation Only, prompt Prompt user to select session., retired Retired, ended Ended, prompt_participant Prompt user to select session with only participant as user who is allowed to select the session, prompt_reviewer Prompt user to select session with only reviewer as user who is allowed to select the session, prompt_participant_reviewer Prompt user to select session with participant and reviewer as users who are allowed to select the session |
Observe System Configuration setting |
| SessionLanguage | Delivery Language | Name of a Predefined Course Language or ISO 2-char codes, e.g., en, fr_CA, es_ES or *AUTO*; Any Text (Max field length:50) |
Auto-Select |
| SessionDeadlineDays | Completion Deadline (Days) | Days from Enrollment (0 implies unlimited) | None |
| SessionDeadlineDate | Completion Deadline (Date) | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) (*NONE* to clear) |
None |
| SessionDeadlineHandling | Completion Deadline Handling | N - Do nothing, the deadline was just for reference; Y - Set transcript to DEADLINE EXPIRED and block learner from launching the course; B - Block learner from launching other courses until they complete this course | N |
| SessionSeatLimitRule | Session Seat Limit Rule | Empty or one of: FIXED Based on min/max enrollment limits, DYNAMIC Based on facility size/capacity |
Depends on learning type |
| SessionMaxUsers | Session Enrollment Limit Maximum | Any Positive Whole Number | None |
| SessionMinUsers | Session Enrollment Limit Minimum | Any Positive Whole Number | None |
| SessionCountPendingInTotal | Reserve seats for learner enrollments pending approval | Y or N |
N |
| SessionWithdrawDaysLimit | Cannot withdraw/transfer within N days of start date | Any Positive Whole Number | None |
| SessionChargeType | Session Charge Procedure | Must be one of: NONE No charge., PER REG Charged per Registration, MODULE Use Module Configured Settings, ONLINE Online Payment, NOT SUPPORTED Organization One Off Token Payment |
Use Module Configured Settings |
| SessionCost | Session Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 | None |
| SessionCurrency | Session Charge Currency | A three letter currency code, e.g., GBP or USD | None |
| SessionPriceInfo | Session Level Currency Cost Price Info | Any Text (Max field length:300) | None |
| SessionCostCenter | Charged Cost Center | Any Text (Max field length:45) | None |
| SessionTokenCost | Session Level Token Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 | None |
| SessionTokenPriceInfo | Session Level Token Cost Price Info | Any Text (Max field length:300) | None |
| SessionWaitListHandling | Session Level Waitlist Handling | Must be one of: AUTO Automatic Upgrade, MANUAL Manual (Administrator) Upgrade, ALL Waitlist all learners., NONE No waitlist, NO-RESERVE Manual (Administrator) Upgrade without Reserving Seats |
AUTO |
| SessionEnrolmentStart | Session Level Enrollment Start Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) | None |
| SessionEnrolmentEnd | Session Level Enrollment End Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) | None |
| SessionTrainingHours | Credits | A decimal value with up to two decimal places, e.g., 12.50 or 5.25 | 0 |
| SessionCustomText | Session Level Custom Text | Any Text (Max field length:255) | None |
| SessionTimeZone | Session Level Time Zone | Time zone ID | System Time Zone |
| SessionInstructors | Session Instructor List | List of user IDs belonging to instructors to be assigned to the session, separated by vertical bar, e.g. instr1^assignmentId1|instr2^assignmentId2|instr3^assignmentId3 | None |
| SessionApprovers | Session Approver List | Up to two user IDs belonging to approvers to be assigned to the session, separated by vertical bar (e.g., appr1^assignmentId1|appr2^assignmentId2) | None |
| SessionGeographicRegion | Session Geographic Region | Name of a Predefined Geographic Region | None |
| SessionAssessmentWorkflowTemplate | Session Assessment Workflow Template Name | Name of a Predefined Assessment Workflow Template (*NONE* to clear) |
None |
| SessionDisableWorkflowAssignment | Disable workflow assignment for the session | Y or N |
N |
| ShowSessionSelectionReminder | Session level Show session selection reminder |
Y or N |
Y |
| SessionAllowPromptSessionSelfEnrollment | Session Level Make Prompt user to select session available for self-enrollment |
Y or N |
N |
| SessionDroppedWaitlistTargetSession | Session Level target session for Transfer users dropped from waitlist to the following session |
Session Code (*NONE* to clear) |
None |
| ClassStart | Class Start Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) | None |
| NewClassStart | New Class Start Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) | None |
| ClassEnd | Class End Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) | None |
| ClassFacilityCode | Class Level Facility Code | Code of Predefined Facility; Any Text (Max field length:85) | None |
| ClassVenue | Class Level Venue | Any Text (Max field length:255) | None |
| ClassRoomName | Class Level Room Name | Any Text (Max field length:255) | None |
| ClassInstructors | Class Instructor List | List of user IDs belonging to instructors to be assigned to the class, separated by vertical bars, e.g., instr1^assignmentId1|instr2^assignmentId2|instr3^assignmentId3 | None |
| Launch.Href | Launch HREF | URL for content launch | None |
| Launch.Interface | Launch Interface | Type of launch handler:; 0 - Generic Web Launch (N/A: Just In Time, Exam, Virtual Classroom); 3 - Structured Content (only applicable to Online); 5 - Resource (N/A: Just In Time, Task, Classroom, Virtual Classroom); 7 - Timed HTML(N/A: Just In Time, Exam, Task, Virtual Classroom); 14 - Rustici Engine; 15 - LTI Tool | None |
| Launch.RuntimeEnvironment | Runtime Environment | Type of runtime environment for Launch Interface 5 - Resource:; g - Generic/none; s - JavaScript API; a - AICC/HACP; x - xAPI (also known as Tin Can API); t - Exam | None |
| Launch.ExamId | Launch Exam Id | Launchable exam identifier | None |
| Launch.LTIToolCode | Launch LTI Tool Code | Launch LTI Tool identifier. This column will be ignored if Rustici Engine Configuration not setup, or Launch.Interface column is empty or value is not 15(LTI Tool). | None |
| Online.Win_Height | Online Window Height | Height (pixels) of window | None |
| Online.Win_Width | Online Window Width | Width (pixels) of window | None |
| Online.Grading_Method | Online Grading Method | Grading Method (online only); H - Highest; A - Average; F - First; L - Last | None |
| Online.Completion_Method | Online Completion Method | Completion Method (online only); A - Auto; M - Manual | None |
| Online.Mastery_Score | Online Mastery Score | Mastery Score (online only) | None |
Request Body schema: text/plainrequired
CSV-formatted course, session, and class data.
Responses
contentHandler/programCsv
This comma-delimited text format (CSV) allows learning programs, including session information and assigned modules, to be added, updated, and deleted.
For more details, refer to the online help of the program CSV loader in Catalog Manager.
Authentication: System authentication.
Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
Action values:
A(Add):- If the program ID doesn't exist, a new program is created.
- If the session ID doesn't exist, a new session is added (
SessionTitlemust be specified). Assigned modules are also added based on the program ID/session ID (to be specified in assigned program and event date). - If the session ID already exists, a new assigned module is added based on the program ID/session ID (to be specified in assigned program and event date).
- If the session ID already exists and the assigned module is already added, the line is not executed.
U(Update):- If the program ID doesn't exist, the line is not executed.
- If the program ID exists and the session ID doesn't exist, program module fields are updated.
- If the session ID exists, program session fields are updated. If assigned module info is filled in, the assigned module is updated (or added, if the course ID is not already assigned).
D(Delete):- If the program ID is entered, the program module is removed from EKP.
- If the program ID and session ID are entered, but not the assigned module course ID and session ID, the session is removed from the program.
- If the program ID and session ID are entered along with the assigned module, the assigned module is removed from the session (not the session from the program).
CSV Fields:
| CSV Header | Mandatory | Default Value | Item as Specified in Catalog Editor | Value |
|---|---|---|---|---|
| Action | Y | None | A/U/D | |
| ProgramID | Y | None | Module ID | A Unique ID That Conforms to PeopleFluent LMS ID constraints (maximum 85 characters) |
| ProgramTitle | N | None | Course Title | Any Text (Max field length:255) |
| ProgramDescription | N | None | Course Description | Any Text (Max field length:None) |
| ProgramMoreInfoHyperlink | N | None | More Information Hyperlink | Any Text (Max field length:500) |
| ProgramDurationComments | N | None | Duration Comments | Any Text (Max field length:100) |
| ProgramSubject | N | None | Subject | Name of a Predefined Course Subject; Any Text (Max field length:50) |
| ProgramImage | N | None | Image for Catalog Display | A valid URL for an image, e.g., http://www.abc.com/abc.png or /ekp/nd/fresco/repository/EKP0002343.jpg; Any Text (Max field length:500) |
| ProgramShowInCatalog | N | N | Show in catalog | Y or N |
| ProgramArchive | N | N | Archive | Y or N |
| ProgramArchiveDate | N | None | Auto-Archive Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) (*NONE* to clear) |
| ProgramPeerComments | N | Y | Allow peer review/comments | Y or N |
| ProgramChargeType | N | No charge. | Module Charge Procedure | Must be one of: NONE No charge., PER REG Charged per Registration, ONLINE Online Payment, NOT SUPPORTED Organization One Off Token Payment |
| ProgramCost | N | None | Course Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 |
| ProgramCurrency | N | None | Module Charge Currency | A three letter currency code, e.g., GBP or USD |
| ProgramPriceInfo | N | None | Currency Cost Price Info | Any Text (Max field length:300) |
| ProgramTokenCost | N | None | Token Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 |
| ProgramTokenPriceInfo | N | None | Token Cost Price Info | Any Text (Max field length:300) |
| ProgramLanguage | N | Observe System Configuration setting Default Language For New Objects |
Language | Name of a Predefined Course Language or ISO 2-char codes, e.g., en, fr_CA, es_ES; Any Text (Max field length:50) |
| ProgramVendor | N | None | Vendor | Name of a Predefined Course Vendor; Any Text (Max field length:255) |
| ProgramCertification | N | None | Certification Name | Name of a Predefined Certification; Any Text (Max field length:1,000) |
| ProgramExams | N | None | Exams | List of predefined exam IDs, delimited by vertical bars, e.g., EXAM1|EXAM2|EXAM3 |
| ProgramExamsMandatory | N | N | Exams are mandatory. | Y or N |
| ProgramExamCompletesModule | N | N | Passing exam(s) automatically completes this module | N - No; Y - Any of the selected exams.; A - All of the selected exams. |
| ProgramEvaluation | N | None | Evaluation | Exam ID of Predefined Evaluation |
| ProgramEvalMandatory | N | N | Mandatory Evaluation | Y or N |
| ProgramCatalogs | N | None | Assign course to catalogs | A list of catalog names, each of which may be hierarchical, separated by a vertical bar, e.g., A/B/C1|A/B/C2 |
| ProgramAudience | N | None | Audience | List of descriptions delimited by vertical bars (|). Each description has a maximum length of 255. |
| ProgramObjectives | N | None | Objectives | List of descriptions delimited by vertical bars (|). Each description has a maximum length of 2,000. |
| ProgramAllowUserWithdraw | N | Y | Allow user to WITHDRAW | Y or N |
| ProgramUserWithdrawReason | N | N | Prompt user for reason for the withdrawal | Y or N |
| ProgramAllowUserComplete | N | Y | Allow user to mark Completed (Self-Asserted) | Y or N |
| ProgramAllowStatusChange | N | N | Allow status changes to be made at any time (e.g., ignore standard business rules) | Y or N |
| ProgramAllowReEnroll | N | Y | Allow re-enrollment | Y or N |
| ProgramEnrollmentPolicy | N | None | Enrollment Policy | Name of a Predefined Enrollment Policy; Any Text (Max field length:50) |
| ProgramRetake | N | Y | Share/credit enrollment | Where a component module/program or its equivalent has been completed by the learner prior to enrolling onto this program, Y if program completion requires the learner to retake the learning, N if program completion does not require the learner to retake the learning. |
| ProgramShareCreditsValidityPeriod | N | 0 | Validity of Learning | Whole positive number or zero |
| ProgramKcEnable | N | Y | Enable the Knowledge Center for this module | Y or N |
| ProgramKcShowPictureArea | N | Y | (KC) AREA: Show picture area | Y, N or I (I, Knowledge Center show picture area configuration inherits from catalog setting) |
| ProgramKcPicture | N | None | KC Picture URL | A valid URL for an image, e.g., http://www.abc.com/abc.png or /ekp/nd/fresco/repository/EKP0002343.jpg; Any Text (Max field length:255) |
| ProgramKcAllowCourseLaunch | N | Y | Allow module launches in KC | Y or N |
| ProgramKcCourseLink | N | N | Course link always launches the KC instead of the course. | Y or N |
| ProgramKcAssessmentWorkflow | N | Y | (KC) AREA: Show assessment workflow area | Y or N |
| ProgramKcCertification | N | Y | (KC) AREA: Show certification area | Y or N |
| ProgramKcContactList | N | Y | (KC) AREA: Show contact list area | Y or N |
| ProgramKcCourseSummary | N | Y | (KC) AREA: Show course summary area | Y or N |
| ProgramKcEvaluation | N | Y | (KC) AREA: Show evaluation area | Y or N |
| ProgramKcForum | N | Y | (KC) AREA: Show forum area | Y or N |
| ProgramKcInstructorList | N | Y | (KC) AREA: Show instructor list area | Y or N |
| ProgramKcNews | N | Y | (KC) AREA: Show news area | Y or N |
| ProgramKcNotepad | N | Y | (KC) AREA: Show notepad area | Y or N |
| ProgramKcPeerComments | N | Y | (KC) AREA: Show peer comments area | Y or N |
| ProgramKcReferences | N | Y | (KC) AREA: Show references area | Y or N |
| ProgramKcStatusChange | N | Y | (KC) AREA: Show status change area | Y or N |
| ProgramKcExam | N | Y | (KC) AREA: Show exam area | Y or N |
| ProgramKcInstructorAboutMe | N | Y | (KC) AREA: Show About Me for the instructor | Y or N |
| ProgramKcInstructorReferences | N | Y | (KC) AREA: Show reference share area for instructors | Y or N |
| ProgramKcFileShare | N | N | (KC) AREA: Show file share area | Y or N |
| ProgramKcHomeworkDropBox | N | N | (KC) AREA: Show homework drop box | Y or N |
| ProgramKcMarkedHomework | N | N | (KC) AREA: Show marked/reviewed homework | Y or N |
| ProgramKcTranscript | N | Y | (KC) AREA: Show transcript area | Y or N |
| ProgramKcQuickEvaluation | N | N | (KC) AREA: Show quick evaluation area | Y or N |
| ProgramKcShowModuleAttributes | N | Y | (KC) AREA: Show Module Attributes | Y or N |
| ProgramCreateWikiSpace | N | N | Create Wiki Space | Y or N |
| ProgramWikiSpaceName | N | Course Title | Wiki Space Name | Any Text (Max field length:None) |
| PermReplace | N | N | Permissions Action | Y - to completely replace permission settings on this course using permissions from the master template.; N - to add to existing permission settings on this course using permissions from the master template. |
| PermTemplateID | N | None | Permissions Template | Learning object ID whose permissions are used as a master template for this course |
| ProgramRequireESignatures | N | N | Require eSignatures | Y or N |
| ProgramSupportContact | N | None | Program Support Contact | Any Text (Max field length:255) |
| AddUserToModuleReadPermissions | N | None | Add user(s) to learning module Read Permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
| RemoveUserFromModuleReadPermissions | N | None | Remove user(s) from learning module read permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
| AddUserToSessionReadPermissions | N | None | Add user(s) to session read permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
| RemoveUserFromSessionReadPermissions | N | None | Remove user(s) from session read permission | List of user IDs, separated by vertical bar (|), e.g. userid1|userid2|userid3 |
| SessionID | N | None | Session Code | Any Text (Max field length:15) |
| SessionTitle | N | None | Session Title | Any Text (Max field length:255) |
| SessionDescription | N | None | Session Description | Any Text (Max field length:None) |
| SessionStatus | N | Observe System Configuration setting | Session Status | Must be one of: active Active, pending Pending, completed Completed, closed Closed, cancelled Cancelled, invitation Invitation Only, prompt_participant Prompt user to select session with only participant as user who is allowed to select the session, prompt_reviewer Prompt user to select session with only reviewer as user who is allowed to select the session, prompt_participant_reviewer Prompt user to select session with participant and reviewer as users who are allowed to select the session, retired Retired, ended Ended |
| SessionAllowPromptSessionSelfEnrollment | N | N | Session Level Make Prompt user to select session available for self-enrollment |
Y or N |
| ShowSessionSelectionReminder | N | N | Session level Show session selection reminder |
Y or N |
| SessionLanguage | N | Auto-Select | Delivery Language | Name of a Predefined Course Language or ISO 2-char codes, e.g., en, fr_CA, es_ES or *AUTO*; Any Text (Max field length:50) |
| SessionDeadlineDays | N | None | Completion Deadline (Days) | Days from Enrollment (0 implies unlimited) |
| SessionDeadlineDate | N | None | Completion Deadline (Date) | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) (*NONE* to clear) |
| SessionDeadlineHandling | N | N | Completion Deadline Handling | N - Do nothing, the deadline was just for reference; Y - Set transcript to DEADLINE EXPIRED and block learner from launching the course; B - Block learner from launching other courses until they complete this course |
| SessionMaxUsers | N | None | Session Enrollment Limit Maximum | Any Positive Whole Number |
| SessionMinUsers | N | None | Session Enrollment Limit Minimum | Any Positive Whole Number |
| SessionCountPendingInTotal | N | N | Reserve seats for learner enrollments pending approval | Y or N |
| SessionWithdrawDaysLimit | N | None | Cannot withdraw/transfer within N days of start date | Any Positive Whole Number |
| SessionWaitListHandling | N | AUTO | Session Level Waitlist Handling | Must be one of: AUTO Automatic Upgrade, MANUAL Manual (Administrator) Upgrade, ALL Waitlist all learners., NONE No waitlist, NO-RESERVE Manual (Administrator) Upgrade without Reserving Seats |
| SessionDroppedWaitlistTargetSession | N | None | Session Level target session for Transfer users dropped from waitlist to the following session |
Session Code (*NONE* to clear) |
| SessionChargeType | N | Use Module Configured Settings | Session Charge Procedure | Must be one of: NONE No charge., PER REG Charged per Registration, MODULE Use Module Configured Settings, ONLINE Online Payment, NOT SUPPORTED Organization One Off Token Payment |
| SessionCost | N | None | Session Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 |
| SessionCurrency | N | None | Session Charge Currency | A three letter currency code, e.g., GBP or USD |
| SessionPriceInfo | N | None | Session Level Currency Cost Price Info | Any Text (Max field length:300) |
| SessionTokenCost | N | None | Session Level Token Cost | A monetary value with up to two decimal places, e.g., 250 or 350.55 |
| SessionTokenPriceInfo | N | None | Session Level Token Cost Price Info | Any Text (Max field length:300) |
| SessionCostCalculation | N | Use amount specified above | Program Cost Calculation | Must be one of: SESSION COST Use amount specified above, TOTAL COST Use total cost of modules in program session (individual debit transactions and a zero debit transaction for the program) |
| SessionTimeZone | N | System Time Zone | Session Level Time Zone | Time zone ID |
| SessionInstructors | N | None | Session Instructor List | List of user IDs belonging to instructors to be assigned to the session, separated by vertical bar, e.g. instr1^assignmentId1|instr2^assignmentId2|instr3^assignmentId3 |
| SessionStart | N | None | Session Level Enrollment Start Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) |
| SessionEnd | N | None | Session Level Enrollment End Date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) |
| SessionApprovers | N | None | Session Approver List | Up to two user IDs belonging to approvers to be assigned to the session, separated by vertical bar (e.g., appr1^assignmentId1|appr2^assignmentId2) |
| SessionPayment | N | N | For program modules with payment configured, enforce payment before first launch. | Y or N |
| SessionOrdered | N | N | Modules cannot be accessed until all preceding modules are completed. | N, Y, YF, YH, or YFH; N and Y are for disabling and enabling the option respectively.; Appending an F will enable the Allow learner to advance to next order on failing preceding learning sub-option. Excluding it implies it should be disabled.; Appending an H will enable the Hide modules blocked by preceding modules in Learner's Available Modules sub-option. Excluding it implies it should be disabled. |
| SessionRevision | N | N | Program completion requires modules to be on Effective/Approved revision | Y if program completion requires modules to be on Effective/Approved revision, otherwise N |
| SessionCredits | N | Y | Use predefined credits | Y or N |
| SessionNumberCredits | N | 0 | Required Credits for Elective Modules | Number |
| SessionPassingScore | N | 0.0 | Passing Score | Positive Number |
| SessionAssessmentWorkflowTemplate | N | None | Session Assessment Workflow Template Name | Name of a Predefined Assessment Workflow Template (*NONE* to clear) |
| SessionDisableWorkflowAssignment | N | N | Disable workflow assignment for the session | Y or N |
| EnrollmentBeginDate | N | None | label.enrollment_begin_date | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) (*NONE* to clear) |
| EnrollmentDeadline | N | None | label.enrollment_deadline | The following formats are accepted:; yyyy-MM-dd HH:mm:ss (e.g. 2010-08-25 13:00:00 denotes August 25, 2010, 1:00 pm); yyyy-MM-dd (e.g. 2012-06-17 denotes June 17, 2012) (*NONE* to clear) |
| SessionAssignedModuleID | N | None | Assigned module | Course ID of Selected Course |
| SessionAssignedModuleSessionID | N | None | Session | Session code for nonprogram type modules; session ID for program type modules |
| SessionAssignedModuleWeight | N | 0.0 | Weighting | Positive Number |
| SessionAssignedModuleOrder | N | 0 | Order | Integer between 0 and 127 |
| SessionAssignedModuleCredits | N | 0 | Credits | Number |
| SessionAssignedModuleRequired | N | Y | Required | Y or N |
| SessionAssignedModuleEnrollment | N | Y | Auto-enroll when available | Y or N |
| SessionAssignedModuleAvailability | N | P(0D) | Available for self-enrollment | One of:; P(1D) where 1 can be replaced by any non-negative integer to denote the number of days after Parent Program Enrollment for availability; O(2D) where 2 can be replaced by any non-negative integer to denote the number of days after advancing to the module order for availability; D(2016-01-31 17:00:00) where 2016-01-31 17:00:00 can be replaced by any date in the same yyyy-MM-dd HH:mm:ss format from which the module will be available |
| SessionAssignedModuleDeadline | N | I | Progress Tracking Deadline | One of; I Inherit from program deadline; P(1D) where 1 can be replaced by any natural integer to denote the number of days after Parent Program Enrollment as a deadline; M(2D) where 2 can be replaced by any natural integer to denote the number of days after Assigned Module Enrollment as a deadline; D(2016-01-31 17:00:00) where 2016-01-31 17:00:00 can be replaced by any date in the same yyyy-MM-dd HH:mm:ss format as a fixed date deadline |
Request Body schema: text/plainrequired
CSV-formatted program, session, and assigned module data.
Responses
competencies
Returns information about competencies.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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
{ }jobProfiles
Returns available job profiles, organized by catalog.
Authentication: User Authentication (required).
query Parameters
| groupBy required | string Default: "catalog" Enum: "catalog" "none"
|
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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
{ }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, |
| 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
{ }jobProfileAssigner
Assigns a job profile to a user.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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, |
| 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
{ }jobProfileUnassigner
Removes a job profile from a user assignment.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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, |
| 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
{ }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
contentHandler/jobProfilesCsv
Allows the addition and modification of job profiles and their competency assignments using the same comma-delimited (CSV) format as the CSV data loader.
Authentication: System authentication.
Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column. You can create a new job profile catalog if it does not exist, but cannot delete one via the data loader.
Action values:
A(Add):- If
JobProfileReferenceCodedoesn't exist, a new job profile is created with the defined properties. - If
CompetencyReferenceCodeis defined, the row is treated as a competency assignment to a job profile record;JobProfileReferenceCodeis required. - If
CompetencyReferenceCodeis defined, the row is treated as a competency assignment to a job profile record andJobProfileReferenceCodeis required. IfALLis specified for the job profile'sJobProfileNumberOfRequired, any newly added competency is tagged as Mandatory.
- If
U(Update):- If
JobProfileReferenceCodedoesn't exist, the row is not processed. - If
CompetencyReferenceCodeis defined and does not exist, the row is not processed. - If
CompetencyReferenceCodeis defined and exists, the row is treated as an update to the competency assignment record.
- If
D(Delete):- If
JobProfileReferenceCodedoesn't exist, the row is not processed. - If
CompetencyReferenceCodeis defined and does not exist, the row is not processed. - If
CompetencyReferenceCodeis defined and exists, the row is treated as a competency assignment removal record (also requiresJobProfileReferenceCode); the job profile record itself is not deleted.
- If
When a change affects the total number of competencies assigned to a job profile, JobProfileNumberOfRequired may need to be updated so it does not exceed the adjusted total number of assigned competencies.
CSV Fields:
| CSV Header | Mandatory | Default Value | Name in Job Profile Creator | Value |
|---|---|---|---|---|
| Action | Y | None | A/U/D | |
| JobProfileReferenceCode | Y | None | Reference Code | A unique reference code (maximum 85 characters) |
| JobProfileName | Y(to add a new job profile) | None | Name | Any text (maximum 85 characters) |
| JobProfileCatalog | N | General |
Job Profile Catalog | Any text (maximum 50 characters) |
| JobProfileOwner | N | None | Job Profile Owner | User ID of the owner (*NONE* to clear) (maximum 255 characters) |
| JobProfileActive | N | N |
Active | Y or N |
| JobProfileDescription | N | None | Description | Any text (*NONE* to clear) (maximum 1,000 characters) |
| JobProfileSelfAssignment | N | N |
Allows Self-Assignment | Y or N |
| JobProfileManualAssignment | N | Y |
Allows Reviewer Assignment | Y or N |
| JobProfileStartDate | N | None | Start date | The following date formats are supported:; dd-mm-yy (e.g. 31-12-13); dd-mm-yyyy (e.g. 31-12-2013) |
| JobProfileEndDate | N | None | End date | The following date formats are supported:; dd-mm-yy (e.g. 31-12-13); dd-mm-yyyy (e.g. 31-12-2013) |
| CompetencyReferenceCode | Y(to add/remove a competency assignment) | None | Competency Name | Must be a cataloged competency code (maximum 85 characters) |
| CompetencyMandatory | N | Y |
Mandatory Flag in Competency Assignment | Y or N |
| CompetencyRequiredLevel | N | None | Required Competency Level | Any text (*NONE* to clear) (maximum 255 characters) |
| CompetencyQuota | N | 0 | Required Number of Users required for this competency | Any integer greater than or equal to 0 |
| JobProfileNumberOfRequired | N | ALL |
Required Number of Competencies | ALL or an integer, lower than, or equal to, the number of assigned competencies at this point |
| Language | N | *ALL* (Multi-Language) |
Language | ISO 2-char codes, e.g., en, fr_CA, es_ES |
| JobProfileAssignmentNotificationForAssignee | N | *DEFAULT* |
Job Profile Assignment Notification for Assignee E-mail | *DEFAULT* for Send in system default template option; Template Name for a custom e-mail notification template; *NOMAIL* for the Do not send option (maximum 100 characters) |
| JobProfileAssignmentNotificationForDirectAppraiser | N | *DEFAULT* |
Job Profile Assignment Notification for Direct Appraisers E-mail | *DEFAULT* for Send in system default template option; Template Name for a custom e-mail notification template; *NOMAIL* for the Do not send option (maximum 100 characters) |
| JobProfileAssignmentNotificationForJobProfileOwner | N | *DEFAULT* |
Job Profile Assignment Notification for Job Profile Owner E-mail | *DEFAULT* for Send in system default template option; Template Name for a custom e-mail notification template; *NOMAIL* for the Do not send option (maximum 100 characters) |
| JobProfileDeAssignmentNotificationForAssignee | N | *DEFAULT* |
Job Profile De-Assignment Notification for Direct Appraisers E-mail | *DEFAULT* for Send in system default template option; Template Name for a custom e-mail notification template; *NOMAIL* for the Do not send option (maximum 100 characters) |
| JobProfileDeAssignmentNotificationForDirectAppraiser | N | *DEFAULT* |
Job Profile De-Assignment Notification for Assignee E-mail | *DEFAULT* for Send in system default template option; Template Name for a custom e-mail notification template; *NOMAIL* for the Do not send option (maximum 100 characters) |
| JobProfileDeAssignmentNotificationForJobProfileOwner | N | *DEFAULT* |
Job Profile De-Assignment Notification for Job Profile Owner E-mail | *DEFAULT* for Send in system default template option; Template Name for a custom e-mail notification template; *NOMAIL* for the Do not send option (maximum 100 characters) |
| AutoAssign-UserGroups | N | None | User Group(s) as Auto-Assign Targets | A list of User Group Names, separated by vertical bars, e.g., group1|group2|group3 |
| AutoAssign-Roles | N | None | System Role(s) as Auto-Assign Targets | A list of System Role IDs, separated by vertical bars, e.g., A|DA|B |
| AutoAssign-Organizations | N | None | Organization(s) as Auto-Assign Targets | A list of Organization Codes, separated by vertical bars, e.g., ROOT/org1|ROOT/org2|ROOT/org3 |
| JobProfileImage | N | None | Job Profile Image (for new UI) | A valid URL for an image, e.g., http://www.abc.com/abc.png or /ekp/nd/fresco/repository/EKP0002343.jpg (*NONE* to clear) (maximum 255 characters) |
| JobProfileGroup1Code | N | None | Job Profile Group 1 Code | Any Text (Max field length:85) |
| JobProfileGroup1Name | N | None | Job Profile Group 1 Name | Any Text (Max field length:85) |
| JobProfileGroup2Code | N | None | Job Profile Group 2 Code | Any Text (Max field length:85) |
| JobProfileGroup2Name | N | None | Job Profile Group 2 Name | Any Text (Max field length:85) |
| JobProfileGroup3Code | N | None | Job Profile Group 3 Code | Any Text (Max field length:85) |
| JobProfileGroup3Name | N | None | Job Profile Group 3 Name | Any Text (Max field length:85) |
| JobProfileGroup4Code | N | None | Job Profile Group 4 Code | Any Text (Max field length:85) |
| JobProfileGroup4Name | N | None | Job Profile Group 4 Name | Any Text (Max field length:85) |
| JobProfileGroup5Code | N | None | Job Profile Group 5 Code | Any Text (Max field length:85) |
| JobProfileGroup5Name | N | None | Job Profile Group 5 Name | Any Text (Max field length:85) |
Request Body schema: text/plainrequired
CSV-formatted job profile data.
Responses
contentHandler/jobProfileAssignmentCsv
Allows the addition, modification, and deletion of job profile assignment types for a user's job profile using the same comma-delimited (CSV) format as the CSV data loader.
Authentication: System authentication.
CSV Fields:
| Field | Content | Mandatory Field | Data Handling |
|---|---|---|---|
| Action | Action | Yes | A for Add, D for Delete, U for Update |
| UserID | User ID | Yes | User ID of a User in the System |
| JobProfileReferenceCode | Job Profile Reference Code | Yes | Reference Code of a Job Profile |
| JobProfileAssignmentType | Job Profile Assignment Type Code | No | Code of a Job Profile Assignment Type (*NONE* to clear) |
Request Body schema: text/plainrequired
CSV-formatted job profile assignment data.
Responses
mailbox
Returns a user's messages.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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
{ }messageUpdater
Marks a message as read.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| id required | string The message ID. |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }latestForumPosts
Returns the most recent forum posts (topics and replies).
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "rss" Enum: "rss" "atom"
|
| 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
assignments
Returns the authenticating user's assignments.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }people
Returns information about people.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }directReports
Returns a user's direct reports.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }me
Returns information about the authenticating user.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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, |
| 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., |
| endDate | string <date-time> Only activities before this date are returned (HTML5/ISO format, e.g., |
| 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
{ }users
Returns information about user accounts.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| userId | string User ID, or empty. |
| organizationId | string Organization ID, or empty. |
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
{ }organization
Returns information about an organization.
Authentication: User Authentication (required).
query Parameters
| id required | string Default: "*ROOT*" The ID of the organization to return ( |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }userGroupCreator
Creates a user group.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| group-name required | string Name of the group to be created. |
| shared | boolean
|
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }userGroupDeleter
Deletes the specified group.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| group-name required | string Name of the group to be deleted. |
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }userGroupAdder
Adds the specified user to the specified group.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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-urlencodedrequired
| 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-urlencodedrequired
| 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-urlencodedrequired
| 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. |
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. |
Responses
contentHandler/usersCsv
Allows the addition, modification, and deletion of users using the same comma-delimited (CSV) format as the CSV user data loader.
Authentication: System authentication.
Adding new users:
- Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
- If a new user is assigned to a particular organization structure (new or existing), the entire organization hierarchy must be included in the CSV. For example, in a four-level organization you must include levels 1, 2, 3, and 4 — intermediate levels (e.g. 2 or 3) may not be omitted.
nlevels are supported, although only 5 are documented below. - If an organization structure is not specified (levels and descriptions left blank), the profile organization structure is used if the option to use a profile is checked. Otherwise, the user is created with an organization structure of
Unassigned. - If an organization description for a level is entered but the corresponding description code is not, that organization level is not added, and a warning message appears in the log file.
- The mandatory fields when adding are:
Action,UserID,FamilyName,GivenName,Password.
Updating existing users:
- Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
- Where supported, the reserved value
*NONE*may be used to clear the field. - Profiles are not used when updating existing users, even if the option is checked.
- Incorrectly formatted records are rejected as invalid data.
- When updating, the only mandatory fields are
ActionandUserID.
CSV Fields:
| Field | Content | Data Handling | Default |
|---|---|---|---|
| Action | Control Action (Either Add, Delete or Update) | Must be A, D, U, or AU (Add, Delete, Update, Add or Update as appropriate) |
None |
| UserID | PeopleFluent LMS User ID | A Unique ID That Conforms to PeopleFluent LMS ID constraints (maximum 85 characters) | None |
| BirthDate(dd-MMM-yyyy) | Date of Birth | The following date formats are supported:; dd-mm-yy (e.g. 31-12-13); dd-mm-yyyy (e.g. 31-12-2013); dd-mmm-yy (e.g. 31-dec-13); dd-mmm-yyyy (e.g. 31-dec-2013); A string of NONE implies no specified date.; For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future. |
None |
| City | Contact Info - City | Any Text (Max field length:50) | None |
| Company Address 1 | Contact Info - Address 1 | Any Text (Max field length:150) | None |
| Company Address 2 | Contact Info - Address 2 | Any Text (Max field length:150) | None |
| CompanyName | Contact Info - Company Name | Any Text (Max field length:50) | None |
| Cost Center | Cost Center | Any Text (Max field length:45) | None |
| Cost Center Name | Cost Center Name | Any Text (Max field length:85) | None |
| Country | Contact Info - Country | Any Text (Max field length:3); Note: ISO 3166-1 alpha-3 | None |
| DeptId | Department ID | Any Text (Max field length:85) | None |
| Department | Department Name | Any Text (Max field length:85) | None |
| Direct Appraiser | Manager -- whoever can authorize | This must be a PeopleFluent LMS User ID.; If System Configuration option "Require Direct Appraiser or Organization Approver to exist for User CSV upload" is enabled then it is required that the Direct Appraiser's User ID should already exists in the system or the non-existing Direct Appraiser has to be defined for creation in a row that is before assigning the Direct Appraiser to a user within the CSV file. If the option is disabled, then it is not required that the Direct Appraiser's User ID should already exist in the system.; System will not automatically create the missing user. | None |
| E-mail Address | Valid E-mail (Max field length:150) | None | |
| Employee Num | Employee Number | Any Text (Max field length:85) | None |
| EmploymentCountryCode | Contact Info - Country | Any Text (Max field length:3); Note: ISO 3166-1 alpha-3 | None |
| ExpirationDate | Expiration Date | The following date formats are supported:; dd-mm-yy (e.g. 31-12-13); dd-mm-yyyy (e.g. 31-12-2013); dd-mmm-yy (e.g. 31-dec-13); dd-mmm-yyyy (e.g. 31-dec-2013); A string of NONE implies no specified date.; For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future. |
None |
| ExternalAuthentication | External Authentication | Y or N |
N |
| DoNotSend | Do not send | Y or N |
N |
| FamilyName | Surname or Last Name | Any Text (Max field length:85) | None |
| Gender | Gender | Any Text (Max field length:1) | None |
| GivenName | First Name | Any Text (Max field length:85) | None |
| HR Mgr | For E-mails/Approvals | Any Text (Max field length:85); Special Cases | None |
| HR Mgr Email | For E-mails/Approvals | Any Text (Max field length:85) | None |
| LanguagePref | Language | ISO 2-char codes: en, fr_CA, es_ES,... | None |
| ManagerName | Manager Name | Any Text (Max field length:85) | None |
| ManagerEmail | Manager E-mail | Any Text (Max field length:85) | None |
| Job Title | Title of Employee | Any Text (Max field length:85) | None |
| Join Date(dd-MMM-yyyy) | Date the Employee Joined the Company | The following date formats are supported:; dd-mm-yy (e.g. 31-12-13); dd-mm-yyyy (e.g. 31-12-2013); dd-mmm-yy (e.g. 31-dec-13); dd-mmm-yyyy (e.g. 31-dec-2013); A string of NONE implies no specified date.; For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future. |
None |
| Location Code | Location Code | Any Text (Max field length:85) | None |
| MiddleName | Middle Name | Any Text (Max field length:85) | None |
| Mobile | Contact Info - Mobile | Any Text (Max field length:85) | None |
| OtherName | Other Name | Any Text (Max field length:85) | None |
| Password | Password | Any string that meets the system-configured password security requirements; Use the *GENERATE* value for a system-generated password to be included in the New Welcome User email for a newly created user. |
None |
| Personal Title | Title of the Person (Mr., Mrs., Dr. ...) | Any of Currently Defined Titles | None |
| Phone | Phone Number | Any Text (Max field length:85) | None |
| PostalCode | Contact Info - Postal Code/ZIP | Any Text (Max field length:50) | None |
| Province State | Contact Info - Province/State | Any Text (Max field length:50) | None |
| Skin | Skin | Skin Name | System Default |
| EnableNewUI | Enable new UI | Y or N |
N |
| Status | Status of User (Either Active, Suspended or Closed) | Must be Active, Suspend, or Close (not case sensitive) |
Active |
| TeleFax | Contact Info - Telefax | Any Text (Max field length:85) | None |
| TimeZone | Time Zone | Time zone ID | None |
| Email Forwarding | E-mail Forwarding | Must be N, D, H, O, E (N/A, Direct Appraiser, HR Manager e-mail, Organization Approver, E-mail address as entered below) |
N |
| Forwarding Email Address | Alternative Mail | Valid E-mail (Max field length:150) | None |
| User Option 1 | User Option 1 | Any Text (Max field length:100) | None |
| User Option 2 | User Option 2 | Any Text (Max field length:100) | None |
| User Option 3 | User Option 3 | Any Text (Max field length:100) | None |
| UserRole | User Role ID | Any Text (Max field length:85) | None |
| AdditionalRoles | Additional Roles | A list of Role IDs separated by a space e.g. S G M D or just ONE letter e.g. S. This column is ignored if the System Configuration option 'Allow additional roles' is disabled. |
None |
| AssignRoles | Assign Roles | A list of Role IDs separated by a space e.g. S G M D or just ONE letter e.g. S. This column is ignored if the System Configuration option 'Allow additional roles' is disabled. |
None |
| UnassignRoles | Unassign Roles | A list of Role IDs separated by a space e.g. S G M D or just ONE letter e.g. S. This column is ignored if the System Configuration option 'Allow additional roles' is disabled. |
None |
| UserAttr1 | User-Defined Attribute 1 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr2 | User-Defined Attribute 2 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr3 | User-Defined Attribute 3 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr4 | User-Defined Attribute 4 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr5 | User-Defined Attribute 5 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr6 | User-Defined Attribute 6 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr7 | User-Defined Attribute 7 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| UserAttr8 | User-Defined Attribute 8 | If configured as drop-down boxes, value should be user attribute code, max field length:85. Otherwise, max field length: 1,000 | None |
| initialURL | First Screen | Screen ID must be a number (Home - 0, Learn - 2, Current Modules - 3, Enrollment Approval - 10, Manage - 11, Learning Path - 12, Catalog Browser - 13, Catalog Search - 14, Records/Transcript - 15, Career Center Summary - 16, Dashboard - 17, Review - 18, Session Administration - 19, Widget Page - 20) | System Default |
| NewUserId | PeopleFluent LMS User ID | A Unique ID That Conforms to PeopleFluent LMS ID constraints | None |
| Content Server | Content Server Name | Value should correspond to a Content Server Name | No content server |
| Supervised Groups | User groups supervised by the User | User group names separated by vertical bars, e.g., group1|group2|group3 | None |
| Supervised Organizations | Supervised Organizations | Full organization hierarchy to be supervised by the user in question with level codes separated by forward slash, use vertical bar to separate between multiple hierarchies, e.g., ROOT/level1org/level2org|ROOT/level2org/level3org | None |
| Supervised Users | Users supervised by the User | List of user IDs to be supervised by the User, separated by vertical bars, e.g., userId1^assignmentId1|userId2^assignmentId2|userId3^assignmentId3. This column is ignored if the System Configuration options 'Allow individual users on Supervises tab' is disabled. | None |
| User Profile Account | User Profile Account | Y or N |
N |
| JobProfiles | Job Profiles | A list of job profile reference codes, separated by vertical bars, e.g., ENGINEER|IT_CONSULTANT | None |
| User Group | User Groups where User is specifically identified as a member | A list of User Group Names, separated by vertical bars, e.g., group1|group2|group3 | None |
| SendResetPasswordMail | Reset Password with System-Generated Password | Y or N; Reset password on an existing user using a system-generated password to be included in the New Password email. This is applicable for Update action and any Password value defined is ignored.; Ensure that it's an one-time update on an existing user instead of a recurring user update job. |
N |
| EnableMfaBypass | Enable MFA/OTP Bypass | Y or N (This setting will be ignored if MFA is disabled in the system configuration.) |
N |
| Job Profile Groups | Job Profile Group Association | Reference code of Job profile groups separated by vertical bars, e.g., Refcode1|Refcode2|Refcode3; Use the *ALL* to assign all of job profile groups to the user; Use the *NONE* to clear assigned job profile groups. This column is ignored if the System Configuration options 'Enable job profile groups' and 'Enable job profile group association at the user level' are disabled. |
None |
| EnableSlack | Enable Slack Notifications | Y or N |
N |
| SlackNotifications | Select notifications to send to Slack | Only notifications sent TO me - 0, Both notifications sent TO me and where I am copied - 1 | 0 |
| Slack Workspace | Slack Workspace | Slack workspace name | None |
| EnableTeams | Enable Microsoft Teams Notifications | Y or N |
N |
| TeamsNotifications | Select notifications to send to Microsoft Teams | Only notifications sent TO me - 0, Both notifications sent TO me and where I am copied - 1 | 0 |
| TeamsConfiguration | MS Teams Application | MS Teams Application Name | None |
| Level1Code | Org Hierarchy Level 1 Code | Any Text (Max field length:255) | Unassigned |
| Level1Desc | Org Hierarchy Level 1 Description | Any Text (Max field length:255) | None |
| Level1ApproverID | Organization Level 1 Approver | It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file. | None |
| Level2Code | Org Hierarchy Level 2 Code | Any Text (Max field length:255) | Unassigned |
| Level2Desc | Org Hierarchy Level 2 Description | Any Text (Max field length:255) | None |
| Level2ApproverID | Organization Level 2 Approver | It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file. | None |
| Level3Code | Org Hierarchy Level 3 Code | Any Text (Max field length:255) | Unassigned |
| Level3Desc | Org Hierarchy Level 3 Description | Any Text (Max field length:255) | None |
| Level3ApproverID | Organization Level 3 Approver | It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file. | None |
| Level4Code | Org Hierarchy Level 4 Code | Any Text (Max field length:255) | Unassigned |
| Level4Desc | Org Hierarchy Level 4 Description | Any Text (Max field length:255) | None |
| Level4ApproverID | Organization Level 4 Approver | It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file. | None |
| Level5Code | Org Hierarchy Level 5 Code | Any Text (Max field length:255) | Unassigned |
| Level5Desc | Org Hierarchy Level 5 Description | Any Text (Max field length:255) | None |
| Level5ApproverID | Organization Level 5 Approver | It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file. | None |
Request Body schema: text/plainrequired
CSV-formatted user data.
Responses
contentHandler/organizationsCsv
Allows the addition, modification, and deletion of organizations using the same comma-delimited (CSV) format as the CSV data loader.
Authentication: System authentication.
Adding a new organization:
- Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
- If a new organization is to be created under a particular organization structure, ensure the entire parent hierarchy is included in the CSV. For example, to create a new level 5 organization, you must include parent specifications for levels 1, 2, 3, and 4 — intermediate levels (e.g. 2 or 3) may not be omitted.
nlevels are supported, although only 5 are documented below. Org Code/Org DescandParentare used to determine uniqueness; the defined hierarchy should not be duplicated with any existing branch having the same hierarchy.Org Code/Org Descdoes not have to be unique as long as the level belongs to another parent hierarchy.- The mandatory fields when adding are:
Action,Org Code,Org Desc,Parent.
Updating an existing organization:
- Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
- Where supported, the reserved value
*NONE*may be used to clear the field. - Moving an organization level to belong to another parent is not allowed, because the hierarchy needs to be specified in both
ParentandOrg Codeto look up an existing structure for update. Only the description and other properties can be updated on an existing level. Parentcan be empty only when updating the description of the root level.- Incorrectly formatted records are rejected as invalid data.
- When updating, the only mandatory fields are
ActionandOrg Code.
CSV Fields:
| Field | Content | Data Handling | Default |
|---|---|---|---|
| Action | Control Action (Either Add, Delete or Update) | Must be A, D, U, or AU (Add, Delete, Update, Add or Update as appropriate) |
None |
| Org Code | Organization Code | Any Text (Max field length:255) | None |
| Org Desc | Organization Description | Any Text (Max field length:255) | None |
| Parent | The Parent Hierarchy Leading to This Level | The organization hierarchy leading up to this level with organization code separated by /, e.g., ROOT/level1org/level2org | None |
| Manager Name | Member Edit Privilege - Manager's Name | Y or N |
N |
| Manager Email | Member Edit Privilege - Manager's Email | Y or N |
N |
| Cost Center | Member Edit Privilege - Cost Center | Y or N |
N |
| Location Code | Member Edit Privilege - Location Code | Y or N |
N |
| Transcript Review | Transcript Review Access | Inheriting from parents (I) or Review settings (R) |
I |
| Reviewer Transcript Access | Level of Reviewer Transcript Access | Completion Status (C), Overall Progress (D), Overall & Sco Progress (P), Full Details (A) |
None |
| DA Transcript Access | Level of Direct Appraiser Transcript Access | Completion Status (C), Overall Progress (D), Overall & Sco Progress (P), Full Details (A) |
None |
| Instructor Transcript Access | Level of Instructor Transcript Access | Completion Status (C), Overall Progress (D), Overall & Sco Progress (P), Full Details (A) |
None |
| Enrollment Policy | Organizational Enrollment Policy | Policy Name (Max field length:85) | None |
| Assessment Template | Organizational Assessment Template | Assessment Template Name (Max field length:50) | None |
| Payment Plan | Organizational Payment Plan | Payment Plan Name (Max field length:85) | None |
| Token Account | Organizational Token Account | Token Account Name (Max field length:200) | None |
| Payment by Invoice | Organizational Payment by Invoice Setting | Y or N |
N |
| Approver | Organization's Approver | A Unique ID That Conforms to PeopleFluent LMS ID constraints (maximum 85 characters) | None |
| Welcome Email | Organizational Welcome Email | Email Template Name (Max field length:100) | None |
| New Password Email | Organizational New Password Email | Email Template Name (Max field length:100) | None |
| Feedback Address | Organizational Feedback Address | Valid E-mail or Path (Max field length:85) | None |
| Forget Password Email Link URL | Organizational Forget Password Email Send to URL | Valid URL (Max field length:255) | None |
| Logout URL | Organizational Logout URL | Valid Path (Max field length:200) | None |
| Background Image | Organizational Background Image | Image Path (Max field length:255) | None |
| Imprint | Organizational Imprint | Any Text | None |
Request Body schema: text/plainrequired
CSV-formatted organization data.
Responses
contentHandler/tokenAccountCsv
Allows the initialization, addition, and deletion of token accounts using the same comma-delimited (CSV) format as the CSV data loader.
Authentication: System authentication.
Initializing token accounts:
- Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
- If a token account name is not provided, it defaults to the organization structure given in the organization level(s), or the structure derived from the user ID.
- The mandatory fields when initializing are:
Action,Level1Desc/UserId.
Adding tokens to token accounts:
- Ensure the data conforms to the formatting required by the template in the table below. Do not insert commas, as these will cause subsequent data to be treated as a separate column.
- Either the organization structure (i.e. level
xorganization descriptions), user ID, or token account name should be provided. - The mandatory fields when adding are:
Action,Level1Desc/UserId/TokenAccountName,TokenValue.
Deleting token accounts:
- The mandatory fields when deleting are
ActionandTokenAccountName. If more than one matching account is found, the delete fails.
CSV Fields:
| Field | Content | Data Handling | Default |
|---|---|---|---|
| Action | Control Action (Initialize, Add, or Delete) | Must be I, A or D (Initialize, Add or Delete) |
None |
| Level1Desc | Org Hierarchy Level 1 Description | Any Text (Max field length:85) | None |
| Level2Desc | Org Hierarchy Level 2 Description | Any Text (Max field length:85) | None |
| Level3Desc | Org Hierarchy Level 3 Description | Any Text (Max field length:85) | None |
| Level4Desc | Org Hierarchy Level 4 Description | Any Text (Max field length:85) | None |
| Level5Desc | Org Hierarchy Level 5 Description | Any Text (Max field length:85) | None |
| UserId | PeopleFluent LMS User ID | A Unique ID That Conforms to PeopleFluent LMS ID constraints (maximum 85 characters) | None |
| TokenAccountName | Token Account Name | Any Text (Max field length:200) | None |
| TokenValue | Token Value | Positive Number | None |
| ExpiryDate | Expiry Date | The following date formats are supported:; dd-mm-yy (e.g. 31-12-13); dd-mm-yyyy (e.g. 31-12-2013); dd-mmm-yy (e.g. 31-dec-13); dd-mmm-yyyy (e.g. 31-dec-2013); A string of NONE implies no specified date.; For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future. |
None |
| ExpiryTimezone | Time Zone | Time zone ID | None |
Request Body schema: text/plainrequired
CSV-formatted token account data.
Responses
assessmentAttemptHandler
Submission of assessment attempt.
Authentication: User Authentication (required).
Request Body schema: application/x-www-form-urlencodedrequired
| 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
{ }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, |
| 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
{ }batchReports
Returns a listing of batch reports.
Authentication: User Authentication (required).
query Parameters
| format required | string Default: "json" Enum: "json" "xml" The response format, |
| 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
{ }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. |