Class LearningApi

java.lang.Object
com.mypurecloud.sdk.v2.api.LearningApi

public class LearningApi extends Object
  • Constructor Details

    • LearningApi

      public LearningApi()
    • LearningApi

      public LearningApi(ApiClient apiClient)
  • Method Details

    • deleteLearningAssignment

      public void deleteLearningAssignment(String assignmentId) throws IOException, ApiException
      Delete a learning assignment
      Parameters:
      assignmentId - The Learning Assignment ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteLearningAssignmentWithHttpInfo

      public ApiResponse<Void> deleteLearningAssignmentWithHttpInfo(String assignmentId) throws IOException
      Delete a learning assignment
      Parameters:
      assignmentId - The Learning Assignment ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteLearningAssignment

      public void deleteLearningAssignment(DeleteLearningAssignmentRequest request) throws IOException, ApiException
      Delete a learning assignment
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteLearningAssignment

      public ApiResponse<Void> deleteLearningAssignment(ApiRequest<Void> request) throws IOException
      Delete a learning assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteLearningModule

      public void deleteLearningModule(String moduleId) throws IOException, ApiException
      Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteLearningModuleWithHttpInfo

      public ApiResponse<Void> deleteLearningModuleWithHttpInfo(String moduleId) throws IOException
      Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteLearningModule

      public void deleteLearningModule(DeleteLearningModuleRequest request) throws IOException, ApiException
      Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteLearningModule

      public ApiResponse<Void> deleteLearningModule(ApiRequest<Void> request) throws IOException
      Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignment

      public LearningAssignment getLearningAssignment(String assignmentId, List<String> expand) throws IOException, ApiException
      Get Learning Assignment Permission not required if you are the assigned user of the learning assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      expand - Fields to expand in response (optional)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignmentWithHttpInfo

      public ApiResponse<LearningAssignment> getLearningAssignmentWithHttpInfo(String assignmentId, List<String> expand) throws IOException
      Get Learning Assignment Permission not required if you are the assigned user of the learning assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      expand - Fields to expand in response (optional)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignment

      public LearningAssignment getLearningAssignment(GetLearningAssignmentRequest request) throws IOException, ApiException
      Get Learning Assignment Permission not required if you are the assigned user of the learning assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignment

      public ApiResponse<LearningAssignment> getLearningAssignment(ApiRequest<Void> request) throws IOException
      Get Learning Assignment Permission not required if you are the assigned user of the learning assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignmentStep

      public LearningAssignmentStep getLearningAssignmentStep(String assignmentId, String stepId, String shareableContentObjectId, String defaultShareableContentObject, List<String> expand) throws IOException, ApiException
      Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      stepId - The ID of Learning Assignment Step (required)
      shareableContentObjectId - The ID of SCO to load (optional)
      defaultShareableContentObject - The default SCO to retrieve (optional)
      expand - Fields to expand in response (optional)
      Returns:
      LearningAssignmentStep
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignmentStepWithHttpInfo

      public ApiResponse<LearningAssignmentStep> getLearningAssignmentStepWithHttpInfo(String assignmentId, String stepId, String shareableContentObjectId, String defaultShareableContentObject, List<String> expand) throws IOException
      Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      stepId - The ID of Learning Assignment Step (required)
      shareableContentObjectId - The ID of SCO to load (optional)
      defaultShareableContentObject - The default SCO to retrieve (optional)
      expand - Fields to expand in response (optional)
      Returns:
      LearningAssignmentStep
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignmentStep

      public LearningAssignmentStep getLearningAssignmentStep(GetLearningAssignmentStepRequest request) throws IOException, ApiException
      Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentStep
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignmentStep

      public ApiResponse<LearningAssignmentStep> getLearningAssignmentStep(ApiRequest<Void> request) throws IOException
      Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignments

      public LearningAssignmentsDomainEntity getLearningAssignments(String moduleId, String interval, String completionInterval, String overdue, Integer pageSize, Integer pageNumber, String pass, Float minPercentageScore, Float maxPercentageScore, String sortOrder, String sortBy, List<String> userId, List<String> types, List<String> states, List<String> expand) throws IOException, ApiException
      List of Learning module Assignments Either moduleId or user value is required
      Parameters:
      moduleId - Specifies the ID of the learning module. Fetch assignments for learning module ID (optional)
      interval - Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      completionInterval - Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned (optional, default to Any)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      pass - Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned (optional, default to Any)
      minPercentageScore - The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      maxPercentageScore - The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      sortOrder - Specifies result set sort order; if not specified, default sort order is descending (Desc) (optional, default to Desc)
      sortBy - Specifies which field to sort the results by, default sort is by recommendedCompletionDate (optional)
      userId - Specifies the list of user IDs to be queried, up to 100 user IDs. (optional)
      types - Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated (optional)
      states - Specifies the assignment states to filter by (optional)
      expand - Specifies the expand option for returning additional information (optional)
      Returns:
      LearningAssignmentsDomainEntity
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignmentsWithHttpInfo

      public ApiResponse<LearningAssignmentsDomainEntity> getLearningAssignmentsWithHttpInfo(String moduleId, String interval, String completionInterval, String overdue, Integer pageSize, Integer pageNumber, String pass, Float minPercentageScore, Float maxPercentageScore, String sortOrder, String sortBy, List<String> userId, List<String> types, List<String> states, List<String> expand) throws IOException
      List of Learning module Assignments Either moduleId or user value is required
      Parameters:
      moduleId - Specifies the ID of the learning module. Fetch assignments for learning module ID (optional)
      interval - Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      completionInterval - Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned (optional, default to Any)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      pass - Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned (optional, default to Any)
      minPercentageScore - The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      maxPercentageScore - The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      sortOrder - Specifies result set sort order; if not specified, default sort order is descending (Desc) (optional, default to Desc)
      sortBy - Specifies which field to sort the results by, default sort is by recommendedCompletionDate (optional)
      userId - Specifies the list of user IDs to be queried, up to 100 user IDs. (optional)
      types - Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated (optional)
      states - Specifies the assignment states to filter by (optional)
      expand - Specifies the expand option for returning additional information (optional)
      Returns:
      LearningAssignmentsDomainEntity
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignments

      List of Learning module Assignments Either moduleId or user value is required
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentsDomainEntity
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignments

      public ApiResponse<LearningAssignmentsDomainEntity> getLearningAssignments(ApiRequest<Void> request) throws IOException
      List of Learning module Assignments Either moduleId or user value is required
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignmentsMe

      public LearningAssignmentsDomainEntity getLearningAssignmentsMe(String moduleId, String interval, String completionInterval, String overdue, Integer pageSize, Integer pageNumber, String pass, Float minPercentageScore, Float maxPercentageScore, String sortOrder, String sortBy, List<String> types, List<String> states, List<String> expand) throws IOException, ApiException
      List of Learning Assignments assigned to current user
      Parameters:
      moduleId - Specifies the ID of the learning module. Fetch assignments for learning module ID (optional)
      interval - Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      completionInterval - Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned (optional, default to Any)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      pass - Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned (optional, default to Any)
      minPercentageScore - The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      maxPercentageScore - The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      sortOrder - Specifies result set sort order; if not specified, default sort order is descending (Desc) (optional, default to Desc)
      sortBy - Specifies which field to sort the results by, default sort is by recommendedCompletionDate (optional)
      types - Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated (optional)
      states - Specifies the assignment states to filter by (optional)
      expand - Specifies the expand option for returning additional information (optional)
      Returns:
      LearningAssignmentsDomainEntity
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignmentsMeWithHttpInfo

      public ApiResponse<LearningAssignmentsDomainEntity> getLearningAssignmentsMeWithHttpInfo(String moduleId, String interval, String completionInterval, String overdue, Integer pageSize, Integer pageNumber, String pass, Float minPercentageScore, Float maxPercentageScore, String sortOrder, String sortBy, List<String> types, List<String> states, List<String> expand) throws IOException
      List of Learning Assignments assigned to current user
      Parameters:
      moduleId - Specifies the ID of the learning module. Fetch assignments for learning module ID (optional)
      interval - Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      completionInterval - Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned (optional, default to Any)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      pass - Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned (optional, default to Any)
      minPercentageScore - The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      maxPercentageScore - The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional)
      sortOrder - Specifies result set sort order; if not specified, default sort order is descending (Desc) (optional, default to Desc)
      sortBy - Specifies which field to sort the results by, default sort is by recommendedCompletionDate (optional)
      types - Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated (optional)
      states - Specifies the assignment states to filter by (optional)
      expand - Specifies the expand option for returning additional information (optional)
      Returns:
      LearningAssignmentsDomainEntity
      Throws:
      IOException - if the request fails to be processed
    • getLearningAssignmentsMe

      List of Learning Assignments assigned to current user
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentsDomainEntity
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningAssignmentsMe

      public ApiResponse<LearningAssignmentsDomainEntity> getLearningAssignmentsMe(ApiRequest<Void> request) throws IOException
      List of Learning Assignments assigned to current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModule

      public LearningModule getLearningModule(String moduleId, List<String> expand) throws IOException, ApiException
      Get a learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      expand - Fields to expand in response(case insensitive) (optional)
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleWithHttpInfo

      public ApiResponse<LearningModule> getLearningModuleWithHttpInfo(String moduleId, List<String> expand) throws IOException
      Get a learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      expand - Fields to expand in response(case insensitive) (optional)
      Returns:
      LearningModule
      Throws:
      IOException - if the request fails to be processed
    • getLearningModule

      public LearningModule getLearningModule(GetLearningModuleRequest request) throws IOException, ApiException
      Get a learning module
      Parameters:
      request - The request object
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModule

      public ApiResponse<LearningModule> getLearningModule(ApiRequest<Void> request) throws IOException
      Get a learning module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModuleJob

      public LearningModuleJobResponse getLearningModuleJob(String moduleId, String jobId) throws IOException, ApiException
      Get a specific Learning Module job status
      Parameters:
      moduleId - The ID of the learning module (required)
      jobId - The ID of the learning module job (required)
      Returns:
      LearningModuleJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleJobWithHttpInfo

      public ApiResponse<LearningModuleJobResponse> getLearningModuleJobWithHttpInfo(String moduleId, String jobId) throws IOException
      Get a specific Learning Module job status
      Parameters:
      moduleId - The ID of the learning module (required)
      jobId - The ID of the learning module job (required)
      Returns:
      LearningModuleJobResponse
      Throws:
      IOException - if the request fails to be processed
    • getLearningModuleJob

      public LearningModuleJobResponse getLearningModuleJob(GetLearningModuleJobRequest request) throws IOException, ApiException
      Get a specific Learning Module job status
      Parameters:
      request - The request object
      Returns:
      LearningModuleJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleJob

      public ApiResponse<LearningModuleJobResponse> getLearningModuleJob(ApiRequest<Void> request) throws IOException
      Get a specific Learning Module job status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModulePreview

      public LearningModulePreviewGetResponse getLearningModulePreview(String moduleId) throws IOException, ApiException
      Get a learning module preview
      Parameters:
      moduleId - The ID of the learning module (required)
      Returns:
      LearningModulePreviewGetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulePreviewWithHttpInfo

      public ApiResponse<LearningModulePreviewGetResponse> getLearningModulePreviewWithHttpInfo(String moduleId) throws IOException
      Get a learning module preview
      Parameters:
      moduleId - The ID of the learning module (required)
      Returns:
      LearningModulePreviewGetResponse
      Throws:
      IOException - if the request fails to be processed
    • getLearningModulePreview

      Get a learning module preview
      Parameters:
      request - The request object
      Returns:
      LearningModulePreviewGetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulePreview

      public ApiResponse<LearningModulePreviewGetResponse> getLearningModulePreview(ApiRequest<Void> request) throws IOException
      Get a learning module preview
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModuleRule

      public LearningModuleRule getLearningModuleRule(String moduleId) throws IOException, ApiException
      Get a learning module rule
      Parameters:
      moduleId - The ID of the learning module (required)
      Returns:
      LearningModuleRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleRuleWithHttpInfo

      public ApiResponse<LearningModuleRule> getLearningModuleRuleWithHttpInfo(String moduleId) throws IOException
      Get a learning module rule
      Parameters:
      moduleId - The ID of the learning module (required)
      Returns:
      LearningModuleRule
      Throws:
      IOException - if the request fails to be processed
    • getLearningModuleRule

      public LearningModuleRule getLearningModuleRule(GetLearningModuleRuleRequest request) throws IOException, ApiException
      Get a learning module rule
      Parameters:
      request - The request object
      Returns:
      LearningModuleRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleRule

      public ApiResponse<LearningModuleRule> getLearningModuleRule(ApiRequest<Void> request) throws IOException
      Get a learning module rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModuleVersion

      public LearningModule getLearningModuleVersion(String moduleId, String versionId, List<String> expand) throws IOException, ApiException
      Get specific version of a published module
      Parameters:
      moduleId - The ID of the learning module (required)
      versionId - The version of learning module (required)
      expand - Fields to expand in response(case insensitive) (optional)
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleVersionWithHttpInfo

      public ApiResponse<LearningModule> getLearningModuleVersionWithHttpInfo(String moduleId, String versionId, List<String> expand) throws IOException
      Get specific version of a published module
      Parameters:
      moduleId - The ID of the learning module (required)
      versionId - The version of learning module (required)
      expand - Fields to expand in response(case insensitive) (optional)
      Returns:
      LearningModule
      Throws:
      IOException - if the request fails to be processed
    • getLearningModuleVersion

      public LearningModule getLearningModuleVersion(GetLearningModuleVersionRequest request) throws IOException, ApiException
      Get specific version of a published module
      Parameters:
      request - The request object
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModuleVersion

      public ApiResponse<LearningModule> getLearningModuleVersion(ApiRequest<Void> request) throws IOException
      Get specific version of a published module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModules

      public LearningModuleList getLearningModules(Boolean isArchived, List<String> types, Integer pageSize, Integer pageNumber, String sortOrder, String sortBy, String searchTerm, List<String> expand, String isPublished, List<String> statuses, List<String> externalIds) throws IOException, ApiException
      Get all learning modules of an organization
      Parameters:
      isArchived - Archive status (optional, default to false)
      types - Specifies the module types. Informational, AssessedContent and Assessment are deprecated (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order (optional, default to ascending)
      sortBy - Sort by (optional, default to name)
      searchTerm - Search Term (searchable by name) (optional)
      expand - Fields to expand in response(case insensitive) (optional)
      isPublished - Specifies if only the Unpublished (isPublished is \"False\") or Published (isPublished is \"True\") modules are returned. If isPublished is \"Any\" or omitted, both types are returned (optional, default to Any)
      statuses - Specifies the module statuses to filter by (optional)
      externalIds - Specifies the module external IDs to filter by. Only one ID is allowed (optional)
      Returns:
      LearningModuleList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulesWithHttpInfo

      public ApiResponse<LearningModuleList> getLearningModulesWithHttpInfo(Boolean isArchived, List<String> types, Integer pageSize, Integer pageNumber, String sortOrder, String sortBy, String searchTerm, List<String> expand, String isPublished, List<String> statuses, List<String> externalIds) throws IOException
      Get all learning modules of an organization
      Parameters:
      isArchived - Archive status (optional, default to false)
      types - Specifies the module types. Informational, AssessedContent and Assessment are deprecated (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order (optional, default to ascending)
      sortBy - Sort by (optional, default to name)
      searchTerm - Search Term (searchable by name) (optional)
      expand - Fields to expand in response(case insensitive) (optional)
      isPublished - Specifies if only the Unpublished (isPublished is \"False\") or Published (isPublished is \"True\") modules are returned. If isPublished is \"Any\" or omitted, both types are returned (optional, default to Any)
      statuses - Specifies the module statuses to filter by (optional)
      externalIds - Specifies the module external IDs to filter by. Only one ID is allowed (optional)
      Returns:
      LearningModuleList
      Throws:
      IOException - if the request fails to be processed
    • getLearningModules

      public LearningModuleList getLearningModules(GetLearningModulesRequest request) throws IOException, ApiException
      Get all learning modules of an organization
      Parameters:
      request - The request object
      Returns:
      LearningModuleList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModules

      public ApiResponse<LearningModuleList> getLearningModules(ApiRequest<Void> request) throws IOException
      Get all learning modules of an organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModulesAssignments

      public AssignedLearningModuleDomainEntityListing getLearningModulesAssignments(List<String> userIds, Integer pageSize, Integer pageNumber, String searchTerm, String overdue, List<String> assignmentStates, List<String> expand) throws IOException, ApiException
      Get all learning modules of an organization including assignments for a specific user
      Parameters:
      userIds - The IDs of the users to include (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      searchTerm - Search Term (searches by name and description) (optional)
      overdue - Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned. (optional, default to Any)
      assignmentStates - Specifies the assignment states to return. (optional)
      expand - Fields to expand in response(case insensitive) (optional)
      Returns:
      AssignedLearningModuleDomainEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulesAssignmentsWithHttpInfo

      public ApiResponse<AssignedLearningModuleDomainEntityListing> getLearningModulesAssignmentsWithHttpInfo(List<String> userIds, Integer pageSize, Integer pageNumber, String searchTerm, String overdue, List<String> assignmentStates, List<String> expand) throws IOException
      Get all learning modules of an organization including assignments for a specific user
      Parameters:
      userIds - The IDs of the users to include (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      searchTerm - Search Term (searches by name and description) (optional)
      overdue - Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned. (optional, default to Any)
      assignmentStates - Specifies the assignment states to return. (optional)
      expand - Fields to expand in response(case insensitive) (optional)
      Returns:
      AssignedLearningModuleDomainEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getLearningModulesAssignments

      Get all learning modules of an organization including assignments for a specific user
      Parameters:
      request - The request object
      Returns:
      AssignedLearningModuleDomainEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulesAssignments

      public ApiResponse<AssignedLearningModuleDomainEntityListing> getLearningModulesAssignments(ApiRequest<Void> request) throws IOException
      Get all learning modules of an organization including assignments for a specific user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningModulesCoverartCoverArtId

      public LearningModuleCoverArtResponse getLearningModulesCoverartCoverArtId(String coverArtId) throws IOException, ApiException
      Get a specific Learning Module cover art using ID
      Parameters:
      coverArtId - Key identifier for the cover art (required)
      Returns:
      LearningModuleCoverArtResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulesCoverartCoverArtIdWithHttpInfo

      public ApiResponse<LearningModuleCoverArtResponse> getLearningModulesCoverartCoverArtIdWithHttpInfo(String coverArtId) throws IOException
      Get a specific Learning Module cover art using ID
      Parameters:
      coverArtId - Key identifier for the cover art (required)
      Returns:
      LearningModuleCoverArtResponse
      Throws:
      IOException - if the request fails to be processed
    • getLearningModulesCoverartCoverArtId

      public LearningModuleCoverArtResponse getLearningModulesCoverartCoverArtId(GetLearningModulesCoverartCoverArtIdRequest request) throws IOException, ApiException
      Get a specific Learning Module cover art using ID
      Parameters:
      request - The request object
      Returns:
      LearningModuleCoverArtResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningModulesCoverartCoverArtId

      public ApiResponse<LearningModuleCoverArtResponse> getLearningModulesCoverartCoverArtId(ApiRequest<Void> request) throws IOException
      Get a specific Learning Module cover art using ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningScheduleslotsJob

      public LearningScheduleSlotsJobResponse getLearningScheduleslotsJob(String jobId) throws IOException, ApiException
      Retrieve the status of the job for the slots where a learning activity can be scheduled.
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      LearningScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningScheduleslotsJobWithHttpInfo

      public ApiResponse<LearningScheduleSlotsJobResponse> getLearningScheduleslotsJobWithHttpInfo(String jobId) throws IOException
      Retrieve the status of the job for the slots where a learning activity can be scheduled.
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      LearningScheduleSlotsJobResponse
      Throws:
      IOException - if the request fails to be processed
    • getLearningScheduleslotsJob

      Retrieve the status of the job for the slots where a learning activity can be scheduled.
      Parameters:
      request - The request object
      Returns:
      LearningScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningScheduleslotsJob

      public ApiResponse<LearningScheduleSlotsJobResponse> getLearningScheduleslotsJob(ApiRequest<Void> request) throws IOException
      Retrieve the status of the job for the slots where a learning activity can be scheduled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getLearningScormScormId

      public LearningScormResponse getLearningScormScormId(String scormId) throws IOException, ApiException
      Get Learning SCORM Result
      Parameters:
      scormId - The ID of the SCORM package (required)
      Returns:
      LearningScormResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningScormScormIdWithHttpInfo

      public ApiResponse<LearningScormResponse> getLearningScormScormIdWithHttpInfo(String scormId) throws IOException
      Get Learning SCORM Result
      Parameters:
      scormId - The ID of the SCORM package (required)
      Returns:
      LearningScormResponse
      Throws:
      IOException - if the request fails to be processed
    • getLearningScormScormId

      public LearningScormResponse getLearningScormScormId(GetLearningScormScormIdRequest request) throws IOException, ApiException
      Get Learning SCORM Result
      Parameters:
      request - The request object
      Returns:
      LearningScormResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getLearningScormScormId

      public ApiResponse<LearningScormResponse> getLearningScormScormId(ApiRequest<Void> request) throws IOException
      Get Learning SCORM Result
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchLearningAssignment

      public LearningAssignment patchLearningAssignment(String assignmentId, LearningAssignmentUpdate body) throws IOException, ApiException
      Update Learning Assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      body - The Learning Assignment to be updated (optional)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningAssignmentWithHttpInfo

      public ApiResponse<LearningAssignment> patchLearningAssignmentWithHttpInfo(String assignmentId, LearningAssignmentUpdate body) throws IOException
      Update Learning Assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      body - The Learning Assignment to be updated (optional)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • patchLearningAssignment

      public LearningAssignment patchLearningAssignment(PatchLearningAssignmentRequest request) throws IOException, ApiException
      Update Learning Assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningAssignment

      public ApiResponse<LearningAssignment> patchLearningAssignment(ApiRequest<LearningAssignmentUpdate> request) throws IOException
      Update Learning Assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchLearningAssignmentReschedule

      public LearningAssignment patchLearningAssignmentReschedule(String assignmentId, LearningAssignmentReschedule body) throws IOException, ApiException
      Reschedule Learning Assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      body - The Learning assignment reschedule model (optional)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningAssignmentRescheduleWithHttpInfo

      public ApiResponse<LearningAssignment> patchLearningAssignmentRescheduleWithHttpInfo(String assignmentId, LearningAssignmentReschedule body) throws IOException
      Reschedule Learning Assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      body - The Learning assignment reschedule model (optional)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • patchLearningAssignmentReschedule

      public LearningAssignment patchLearningAssignmentReschedule(PatchLearningAssignmentRescheduleRequest request) throws IOException, ApiException
      Reschedule Learning Assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningAssignmentReschedule

      public ApiResponse<LearningAssignment> patchLearningAssignmentReschedule(ApiRequest<LearningAssignmentReschedule> request) throws IOException
      Reschedule Learning Assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchLearningAssignmentStep

      public LearningAssignmentStep patchLearningAssignmentStep(String assignmentId, String stepId, LearningAssignmentStep body) throws IOException, ApiException
      Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      stepId - The ID of Learning Assignment Step (required)
      body - The Learning Assignment Step to be updated (optional)
      Returns:
      LearningAssignmentStep
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningAssignmentStepWithHttpInfo

      public ApiResponse<LearningAssignmentStep> patchLearningAssignmentStepWithHttpInfo(String assignmentId, String stepId, LearningAssignmentStep body) throws IOException
      Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      assignmentId - The ID of Learning Assignment (required)
      stepId - The ID of Learning Assignment Step (required)
      body - The Learning Assignment Step to be updated (optional)
      Returns:
      LearningAssignmentStep
      Throws:
      IOException - if the request fails to be processed
    • patchLearningAssignmentStep

      public LearningAssignmentStep patchLearningAssignmentStep(PatchLearningAssignmentStepRequest request) throws IOException, ApiException
      Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentStep
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningAssignmentStep

      public ApiResponse<LearningAssignmentStep> patchLearningAssignmentStep(ApiRequest<LearningAssignmentStep> request) throws IOException
      Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchLearningModuleUserAssignments

      public LearningAssignment patchLearningModuleUserAssignments(String moduleId, String userId, LearningAssignmentExternalUpdate body) throws IOException, ApiException
      Update an external assignment for a specific user
      Parameters:
      moduleId - Key identifier for the module (required)
      userId - Key identifier for the user (required)
      body - The learning request for updating the assignment (required)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningModuleUserAssignmentsWithHttpInfo

      public ApiResponse<LearningAssignment> patchLearningModuleUserAssignmentsWithHttpInfo(String moduleId, String userId, LearningAssignmentExternalUpdate body) throws IOException
      Update an external assignment for a specific user
      Parameters:
      moduleId - Key identifier for the module (required)
      userId - Key identifier for the user (required)
      body - The learning request for updating the assignment (required)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • patchLearningModuleUserAssignments

      public LearningAssignment patchLearningModuleUserAssignments(PatchLearningModuleUserAssignmentsRequest request) throws IOException, ApiException
      Update an external assignment for a specific user
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchLearningModuleUserAssignments

      public ApiResponse<LearningAssignment> patchLearningModuleUserAssignments(ApiRequest<LearningAssignmentExternalUpdate> request) throws IOException
      Update an external assignment for a specific user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssessmentsScoring

      public AssessmentScoringSet postLearningAssessmentsScoring(LearningAssessmentScoringRequest body) throws IOException, ApiException
      Score learning assessment for preview
      Parameters:
      body - Assessment form and answers to score (required)
      Returns:
      AssessmentScoringSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssessmentsScoringWithHttpInfo

      public ApiResponse<AssessmentScoringSet> postLearningAssessmentsScoringWithHttpInfo(LearningAssessmentScoringRequest body) throws IOException
      Score learning assessment for preview
      Parameters:
      body - Assessment form and answers to score (required)
      Returns:
      AssessmentScoringSet
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssessmentsScoring

      public AssessmentScoringSet postLearningAssessmentsScoring(PostLearningAssessmentsScoringRequest request) throws IOException, ApiException
      Score learning assessment for preview
      Parameters:
      request - The request object
      Returns:
      AssessmentScoringSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssessmentsScoring

      public ApiResponse<AssessmentScoringSet> postLearningAssessmentsScoring(ApiRequest<LearningAssessmentScoringRequest> request) throws IOException
      Score learning assessment for preview
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentReassign

      public LearningAssignment postLearningAssignmentReassign(String assignmentId) throws IOException, ApiException
      Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module
      Parameters:
      assignmentId - The Learning Assignment ID (required)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentReassignWithHttpInfo

      public ApiResponse<LearningAssignment> postLearningAssignmentReassignWithHttpInfo(String assignmentId) throws IOException
      Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module
      Parameters:
      assignmentId - The Learning Assignment ID (required)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentReassign

      public LearningAssignment postLearningAssignmentReassign(PostLearningAssignmentReassignRequest request) throws IOException, ApiException
      Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentReassign

      public ApiResponse<LearningAssignment> postLearningAssignmentReassign(ApiRequest<Void> request) throws IOException
      Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentReset

      public LearningAssignment postLearningAssignmentReset(String assignmentId) throws IOException, ApiException
      Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment
      Parameters:
      assignmentId - The Learning Assignment ID (required)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentResetWithHttpInfo

      public ApiResponse<LearningAssignment> postLearningAssignmentResetWithHttpInfo(String assignmentId) throws IOException
      Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment
      Parameters:
      assignmentId - The Learning Assignment ID (required)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentReset

      public LearningAssignment postLearningAssignmentReset(PostLearningAssignmentResetRequest request) throws IOException, ApiException
      Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentReset

      public ApiResponse<LearningAssignment> postLearningAssignmentReset(ApiRequest<Void> request) throws IOException
      Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignments

      public LearningAssignment postLearningAssignments(LearningAssignmentCreate body) throws IOException, ApiException
      Create Learning Assignment
      Parameters:
      body - The Learning Assignment to be created (optional)
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsWithHttpInfo

      public ApiResponse<LearningAssignment> postLearningAssignmentsWithHttpInfo(LearningAssignmentCreate body) throws IOException
      Create Learning Assignment
      Parameters:
      body - The Learning Assignment to be created (optional)
      Returns:
      LearningAssignment
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignments

      public LearningAssignment postLearningAssignments(PostLearningAssignmentsRequest request) throws IOException, ApiException
      Create Learning Assignment
      Parameters:
      request - The request object
      Returns:
      LearningAssignment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignments

      public ApiResponse<LearningAssignment> postLearningAssignments(ApiRequest<LearningAssignmentCreate> request) throws IOException
      Create Learning Assignment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentsAggregatesQuery

      public LearningAssignmentAggregateResponse postLearningAssignmentsAggregatesQuery(LearningAssignmentAggregateParam body) throws IOException, ApiException
      Retrieve aggregated assignment data
      Parameters:
      body - Aggregate Request (required)
      Returns:
      LearningAssignmentAggregateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsAggregatesQueryWithHttpInfo

      public ApiResponse<LearningAssignmentAggregateResponse> postLearningAssignmentsAggregatesQueryWithHttpInfo(LearningAssignmentAggregateParam body) throws IOException
      Retrieve aggregated assignment data
      Parameters:
      body - Aggregate Request (required)
      Returns:
      LearningAssignmentAggregateResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentsAggregatesQuery

      public LearningAssignmentAggregateResponse postLearningAssignmentsAggregatesQuery(PostLearningAssignmentsAggregatesQueryRequest request) throws IOException, ApiException
      Retrieve aggregated assignment data
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentAggregateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsAggregatesQuery

      public ApiResponse<LearningAssignmentAggregateResponse> postLearningAssignmentsAggregatesQuery(ApiRequest<LearningAssignmentAggregateParam> request) throws IOException
      Retrieve aggregated assignment data
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkadd

      public LearningAssignmentBulkAddResponse postLearningAssignmentsBulkadd(List<LearningAssignmentItem> body) throws IOException, ApiException
      Add multiple learning assignments
      Parameters:
      body - The learning assignments to be created (optional)
      Returns:
      LearningAssignmentBulkAddResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkaddWithHttpInfo

      public ApiResponse<LearningAssignmentBulkAddResponse> postLearningAssignmentsBulkaddWithHttpInfo(List<LearningAssignmentItem> body) throws IOException
      Add multiple learning assignments
      Parameters:
      body - The learning assignments to be created (optional)
      Returns:
      LearningAssignmentBulkAddResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkadd

      Add multiple learning assignments
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentBulkAddResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkadd

      public ApiResponse<LearningAssignmentBulkAddResponse> postLearningAssignmentsBulkadd(ApiRequest<List<LearningAssignmentItem>> request) throws IOException
      Add multiple learning assignments
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkremove

      public LearningAssignmentBulkRemoveResponse postLearningAssignmentsBulkremove(List<String> body) throws IOException, ApiException
      Remove multiple Learning Assignments
      Parameters:
      body - The IDs of the learning assignments to be removed (optional)
      Returns:
      LearningAssignmentBulkRemoveResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkremoveWithHttpInfo

      public ApiResponse<LearningAssignmentBulkRemoveResponse> postLearningAssignmentsBulkremoveWithHttpInfo(List<String> body) throws IOException
      Remove multiple Learning Assignments
      Parameters:
      body - The IDs of the learning assignments to be removed (optional)
      Returns:
      LearningAssignmentBulkRemoveResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkremove

      Remove multiple Learning Assignments
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentBulkRemoveResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningAssignmentsBulkremove

      public ApiResponse<LearningAssignmentBulkRemoveResponse> postLearningAssignmentsBulkremove(ApiRequest<List<String>> request) throws IOException
      Remove multiple Learning Assignments
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningModuleJobs

      public LearningModuleJobResponse postLearningModuleJobs(String moduleId, LearningModuleJobRequest body) throws IOException, ApiException
      Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module job request (required)
      Returns:
      LearningModuleJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModuleJobsWithHttpInfo

      public ApiResponse<LearningModuleJobResponse> postLearningModuleJobsWithHttpInfo(String moduleId, LearningModuleJobRequest body) throws IOException
      Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module job request (required)
      Returns:
      LearningModuleJobResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningModuleJobs

      public LearningModuleJobResponse postLearningModuleJobs(PostLearningModuleJobsRequest request) throws IOException, ApiException
      Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module
      Parameters:
      request - The request object
      Returns:
      LearningModuleJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModuleJobs

      public ApiResponse<LearningModuleJobResponse> postLearningModuleJobs(ApiRequest<LearningModuleJobRequest> request) throws IOException
      Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningModulePublish

      public LearningModulePublishResponse postLearningModulePublish(String moduleId, LearningModulePublishRequest body) throws IOException, ApiException
      Publish a Learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The request body (optional)
      Returns:
      LearningModulePublishResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModulePublishWithHttpInfo

      public ApiResponse<LearningModulePublishResponse> postLearningModulePublishWithHttpInfo(String moduleId, LearningModulePublishRequest body) throws IOException
      Publish a Learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The request body (optional)
      Returns:
      LearningModulePublishResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningModulePublish

      public LearningModulePublishResponse postLearningModulePublish(PostLearningModulePublishRequest request) throws IOException, ApiException
      Publish a Learning module
      Parameters:
      request - The request object
      Returns:
      LearningModulePublishResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModulePublish

      Publish a Learning module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningModuleRuleMigrate

      public LearningModuleMigrateResponse postLearningModuleRuleMigrate(String moduleId) throws IOException, ApiException
      Migrate a legacy learning module rule to a users rule. postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      moduleId - The ID of the learning module (required)
      Returns:
      LearningModuleMigrateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModuleRuleMigrateWithHttpInfo

      public ApiResponse<LearningModuleMigrateResponse> postLearningModuleRuleMigrateWithHttpInfo(String moduleId) throws IOException
      Migrate a legacy learning module rule to a users rule. postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      moduleId - The ID of the learning module (required)
      Returns:
      LearningModuleMigrateResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningModuleRuleMigrate

      public LearningModuleMigrateResponse postLearningModuleRuleMigrate(PostLearningModuleRuleMigrateRequest request) throws IOException, ApiException
      Migrate a legacy learning module rule to a users rule. postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      LearningModuleMigrateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModuleRuleMigrate

      public ApiResponse<LearningModuleMigrateResponse> postLearningModuleRuleMigrate(ApiRequest<Void> request) throws IOException
      Migrate a legacy learning module rule to a users rule. postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningModules

      public LearningModule postLearningModules(LearningModuleRequest body) throws IOException, ApiException
      Create a new learning module This will create a new unpublished learning module with the specified fields.
      Parameters:
      body - The learning module to be created (required)
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModulesWithHttpInfo

      public ApiResponse<LearningModule> postLearningModulesWithHttpInfo(LearningModuleRequest body) throws IOException
      Create a new learning module This will create a new unpublished learning module with the specified fields.
      Parameters:
      body - The learning module to be created (required)
      Returns:
      LearningModule
      Throws:
      IOException - if the request fails to be processed
    • postLearningModules

      public LearningModule postLearningModules(PostLearningModulesRequest request) throws IOException, ApiException
      Create a new learning module This will create a new unpublished learning module with the specified fields.
      Parameters:
      request - The request object
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningModules

      public ApiResponse<LearningModule> postLearningModules(ApiRequest<LearningModuleRequest> request) throws IOException
      Create a new learning module This will create a new unpublished learning module with the specified fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningRulesQuery

      public LearningAssignmentUserListing postLearningRulesQuery(Integer pageSize, Integer pageNumber, LearningAssignmentUserQuery body) throws IOException, ApiException
      Get users for learning module rule This will get the users who matches the given rule.
      Parameters:
      pageSize - Page size (required)
      pageNumber - Page number (required)
      body - The learning module rule to fetch users (required)
      Returns:
      LearningAssignmentUserListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningRulesQueryWithHttpInfo

      public ApiResponse<LearningAssignmentUserListing> postLearningRulesQueryWithHttpInfo(Integer pageSize, Integer pageNumber, LearningAssignmentUserQuery body) throws IOException
      Get users for learning module rule This will get the users who matches the given rule.
      Parameters:
      pageSize - Page size (required)
      pageNumber - Page number (required)
      body - The learning module rule to fetch users (required)
      Returns:
      LearningAssignmentUserListing
      Throws:
      IOException - if the request fails to be processed
    • postLearningRulesQuery

      Get users for learning module rule This will get the users who matches the given rule.
      Parameters:
      request - The request object
      Returns:
      LearningAssignmentUserListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningRulesQuery

      Get users for learning module rule This will get the users who matches the given rule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningScheduleslotsJobs

      Start job to retrieve slots where a learning activity can be scheduled.
      Parameters:
      body - The slots search request (required)
      Returns:
      LearningScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningScheduleslotsJobsWithHttpInfo

      public ApiResponse<LearningScheduleSlotsJobResponse> postLearningScheduleslotsJobsWithHttpInfo(LearningScheduleSlotsJobRequest body) throws IOException
      Start job to retrieve slots where a learning activity can be scheduled.
      Parameters:
      body - The slots search request (required)
      Returns:
      LearningScheduleSlotsJobResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningScheduleslotsJobs

      Start job to retrieve slots where a learning activity can be scheduled.
      Parameters:
      request - The request object
      Returns:
      LearningScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningScheduleslotsJobs

      Start job to retrieve slots where a learning activity can be scheduled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningScheduleslotsQuery

      Get list of possible slots where a learning activity can be scheduled.
      Parameters:
      body - The slot search request (required)
      Returns:
      LearningScheduleSlotsQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningScheduleslotsQueryWithHttpInfo

      public ApiResponse<LearningScheduleSlotsQueryResponse> postLearningScheduleslotsQueryWithHttpInfo(LearningScheduleSlotsQueryRequest body) throws IOException
      Get list of possible slots where a learning activity can be scheduled.
      Parameters:
      body - The slot search request (required)
      Returns:
      LearningScheduleSlotsQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningScheduleslotsQuery

      Get list of possible slots where a learning activity can be scheduled.
      Parameters:
      request - The request object
      Returns:
      LearningScheduleSlotsQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningScheduleslotsQuery

      Get list of possible slots where a learning activity can be scheduled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postLearningScorm

      Create a SCORM package upload request
      Parameters:
      body - The SCORM package to be uploaded (optional)
      Returns:
      LearningScormUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningScormWithHttpInfo

      public ApiResponse<LearningScormUploadResponse> postLearningScormWithHttpInfo(LearningScormUploadRequest body) throws IOException
      Create a SCORM package upload request
      Parameters:
      body - The SCORM package to be uploaded (optional)
      Returns:
      LearningScormUploadResponse
      Throws:
      IOException - if the request fails to be processed
    • postLearningScorm

      Create a SCORM package upload request
      Parameters:
      request - The request object
      Returns:
      LearningScormUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postLearningScorm

      Create a SCORM package upload request
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putLearningModule

      public LearningModule putLearningModule(String moduleId, LearningModuleRequest body) throws IOException, ApiException
      Update a learning module This will update the name, description, completion time in days and inform steps for a learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module to be updated (required)
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putLearningModuleWithHttpInfo

      public ApiResponse<LearningModule> putLearningModuleWithHttpInfo(String moduleId, LearningModuleRequest body) throws IOException
      Update a learning module This will update the name, description, completion time in days and inform steps for a learning module
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module to be updated (required)
      Returns:
      LearningModule
      Throws:
      IOException - if the request fails to be processed
    • putLearningModule

      public LearningModule putLearningModule(PutLearningModuleRequest request) throws IOException, ApiException
      Update a learning module This will update the name, description, completion time in days and inform steps for a learning module
      Parameters:
      request - The request object
      Returns:
      LearningModule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putLearningModule

      public ApiResponse<LearningModule> putLearningModule(ApiRequest<LearningModuleRequest> request) throws IOException
      Update a learning module This will update the name, description, completion time in days and inform steps for a learning module
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putLearningModulePreview

      Update a learning module preview This will update a learning module preview
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module to be updated (required)
      Returns:
      LearningModulePreviewUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putLearningModulePreviewWithHttpInfo

      public ApiResponse<LearningModulePreviewUpdateResponse> putLearningModulePreviewWithHttpInfo(String moduleId, LearningModulePreviewUpdateRequest body) throws IOException
      Update a learning module preview This will update a learning module preview
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module to be updated (required)
      Returns:
      LearningModulePreviewUpdateResponse
      Throws:
      IOException - if the request fails to be processed
    • putLearningModulePreview

      Update a learning module preview This will update a learning module preview
      Parameters:
      request - The request object
      Returns:
      LearningModulePreviewUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putLearningModulePreview

      Update a learning module preview This will update a learning module preview
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putLearningModuleRule

      public LearningModuleRule putLearningModuleRule(String moduleId, LearningModuleRule body, Boolean assign) throws IOException, ApiException
      Update a learning module rule This will update a learning module rule with the specified fields.
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module rule to be updated (required)
      assign - Whether to assign the module to users or not (optional, default to true)
      Returns:
      LearningModuleRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putLearningModuleRuleWithHttpInfo

      public ApiResponse<LearningModuleRule> putLearningModuleRuleWithHttpInfo(String moduleId, LearningModuleRule body, Boolean assign) throws IOException
      Update a learning module rule This will update a learning module rule with the specified fields.
      Parameters:
      moduleId - The ID of the learning module (required)
      body - The learning module rule to be updated (required)
      assign - Whether to assign the module to users or not (optional, default to true)
      Returns:
      LearningModuleRule
      Throws:
      IOException - if the request fails to be processed
    • putLearningModuleRule

      public LearningModuleRule putLearningModuleRule(PutLearningModuleRuleRequest request) throws IOException, ApiException
      Update a learning module rule This will update a learning module rule with the specified fields.
      Parameters:
      request - The request object
      Returns:
      LearningModuleRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putLearningModuleRule

      public ApiResponse<LearningModuleRule> putLearningModuleRule(ApiRequest<LearningModuleRule> request) throws IOException
      Update a learning module rule This will update a learning module rule with the specified fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed