Package com.stackone.stackone_client_java

Class Lms

  • public class Lms
extends java.lang.Object

    • Method Detail

      • async

        public AsyncLms async()
        Switches to the async SDK.
        Returns:
        The async SDK

      • listCourses

        public LmsListCoursesRequestBuilder listCourses()
        List Courses

        Retrieve a list of course type learning objects.

        These are collections of content type learning objects that are grouped together for a specific learning purpose.

        Returns:
        The call builder

      • listCourses

        public LmsListCoursesResponse listCourses​(LmsListCoursesRequest request)
        List Courses

        Retrieve a list of course type learning objects.

        These are collections of content type learning objects that are grouped together for a specific learning purpose.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCourses

        public LmsListCoursesResponse listCourses​(LmsListCoursesRequest request,
                                          java.util.Optional<Options> options)
        List Courses

        Retrieve a list of course type learning objects.

        These are collections of content type learning objects that are grouped together for a specific learning purpose.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCourse

        public LmsGetCourseRequestBuilder getCourse()
        Get Course

        Retrieve a course type learning object by its identifier.

        These are collections of content type learning objects that are grouped together for a specific learning purpose.

        Returns:
        The call builder

      • getCourse

        public LmsGetCourseResponse getCourse​(LmsGetCourseRequest request)
        Get Course

        Retrieve a course type learning object by its identifier.

        These are collections of content type learning objects that are grouped together for a specific learning purpose.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCourse

        public LmsGetCourseResponse getCourse​(LmsGetCourseRequest request,
                                      java.util.Optional<Options> options)
        Get Course

        Retrieve a course type learning object by its identifier.

        These are collections of content type learning objects that are grouped together for a specific learning purpose.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listUserAssignments

        public LmsListUserAssignmentsRequestBuilder listUserAssignments()
        List User Assignments

        Retrieve a list of assignment type learning records for a user.

        These are the records linking a user to learning objects.

        They can be pending, in progress, or completed.

        Returns:
        The call builder

      • listUserAssignments

        public LmsListUserAssignmentsResponse listUserAssignments​(LmsListUserAssignmentsRequest request)
        List User Assignments

        Retrieve a list of assignment type learning records for a user.

        These are the records linking a user to learning objects.

        They can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listUserAssignments

        public LmsListUserAssignmentsResponse listUserAssignments​(LmsListUserAssignmentsRequest request,
                                                          java.util.Optional<Options> options)
        List User Assignments

        Retrieve a list of assignment type learning records for a user.

        These are the records linking a user to learning objects.

        They can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createUserAssignment

        public LmsCreateUserAssignmentRequestBuilder createUserAssignment()
        Create User Assignment

        Create an assignment type learning record for a user.

        This is the record linking a user to a learning object.

        It can be pending or in progress.

        Returns:
        The call builder

      • createUserAssignment

        public LmsCreateUserAssignmentResponse createUserAssignment​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            LmsCreateAssignmentRequestDto lmsCreateAssignmentRequestDto)
        Create User Assignment

        Create an assignment type learning record for a user.

        This is the record linking a user to a learning object.

        It can be pending or in progress.

        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateAssignmentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createUserAssignment

        public LmsCreateUserAssignmentResponse createUserAssignment​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            LmsCreateAssignmentRequestDto lmsCreateAssignmentRequestDto,
                                                            java.util.Optional<Options> options)
        Create User Assignment

        Create an assignment type learning record for a user.

        This is the record linking a user to a learning object.

        It can be pending or in progress.

        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateAssignmentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getUserAssignment

        public LmsGetUserAssignmentRequestBuilder getUserAssignment()
        Get User Assignment

        Retrieve an assignment type learning record for a user by its identifier.

        This is the record linking a user to a learning object.

        It can be pending, in progress, or completed.

        Returns:
        The call builder

      • getUserAssignment

        public LmsGetUserAssignmentResponse getUserAssignment​(LmsGetUserAssignmentRequest request)
        Get User Assignment

        Retrieve an assignment type learning record for a user by its identifier.

        This is the record linking a user to a learning object.

        It can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getUserAssignment

        public LmsGetUserAssignmentResponse getUserAssignment​(LmsGetUserAssignmentRequest request,
                                                      java.util.Optional<Options> options)
        Get User Assignment

        Retrieve an assignment type learning record for a user by its identifier.

        This is the record linking a user to a learning object.

        It can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • batchUpsertContent

        public LmsBatchUpsertContentRequestBuilder batchUpsertContent()
        Batch Upsert External Linking Learning Objects

        Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking.

        **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

        See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.

        Returns:
        The call builder

      • batchUpsertContent

        public LmsBatchUpsertContentResponse batchUpsertContent​(java.lang.String xAccountId,
                                                        LmsBatchUpsertContentRequestDto lmsBatchUpsertContentRequestDto)
        Batch Upsert External Linking Learning Objects

        Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking.

        **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

        See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.

        Parameters:
        xAccountId - The account identifier
        lmsBatchUpsertContentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • batchUpsertContent

        public LmsBatchUpsertContentResponse batchUpsertContent​(java.lang.String xAccountId,
                                                        LmsBatchUpsertContentRequestDto lmsBatchUpsertContentRequestDto,
                                                        java.util.Optional<Options> options)
        Batch Upsert External Linking Learning Objects

        Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking.

        **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

        See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.

        Parameters:
        xAccountId - The account identifier
        lmsBatchUpsertContentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listContent

        public LmsListContentRequestBuilder listContent()
        List Content

        Retrieve a list of content type learning objects.

        These are the most granular learning objects (e.g. video, document, podcast) on a platform.

        Only content objects for which the platform supports progress and completion tracking are returned.

        Returns:
        The call builder

      • listContent

        public LmsListContentResponse listContent​(LmsListContentRequest request)
        List Content

        Retrieve a list of content type learning objects.

        These are the most granular learning objects (e.g. video, document, podcast) on a platform.

        Only content objects for which the platform supports progress and completion tracking are returned.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listContent

        public LmsListContentResponse listContent​(LmsListContentRequest request,
                                          java.util.Optional<Options> options)
        List Content

        Retrieve a list of content type learning objects.

        These are the most granular learning objects (e.g. video, document, podcast) on a platform.

        Only content objects for which the platform supports progress and completion tracking are returned.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • upsertContent

        public LmsUpsertContentRequestBuilder upsertContent()
        Upsert External Linking Learning Objects

        Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking.

        **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

        See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.

        Returns:
        The call builder

      • upsertContent

        public LmsUpsertContentResponse upsertContent​(java.lang.String xAccountId,
                                              LmsUpsertContentRequestDto lmsUpsertContentRequestDto)
        Upsert External Linking Learning Objects

        Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking.

        **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

        See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.

        Parameters:
        xAccountId - The account identifier
        lmsUpsertContentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • upsertContent

        public LmsUpsertContentResponse upsertContent​(java.lang.String xAccountId,
                                              LmsUpsertContentRequestDto lmsUpsertContentRequestDto,
                                              java.util.Optional<Options> options)
        Upsert External Linking Learning Objects

        Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking.

        **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

        See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.

        Parameters:
        xAccountId - The account identifier
        lmsUpsertContentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getContent

        public LmsGetContentRequestBuilder getContent()
        Get Content

        Retrieve a content type learning object by its identifier.

        These are the most granular learning objects (e.g. video, document, podcast) on a platform.

        Only content objects for which the platform supports progress and completion tracking are returned.

        Returns:
        The call builder

      • getContent

        public LmsGetContentResponse getContent​(LmsGetContentRequest request)
        Get Content

        Retrieve a content type learning object by its identifier.

        These are the most granular learning objects (e.g. video, document, podcast) on a platform.

        Only content objects for which the platform supports progress and completion tracking are returned.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getContent

        public LmsGetContentResponse getContent​(LmsGetContentRequest request,
                                        java.util.Optional<Options> options)
        Get Content

        Retrieve a content type learning object by its identifier.

        These are the most granular learning objects (e.g. video, document, podcast) on a platform.

        Only content objects for which the platform supports progress and completion tracking are returned.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listUserCompletions

        public LmsListUserCompletionsRequestBuilder listUserCompletions()
        List User Completions

        Retrieve a list of completed learning records for a user.

        These are the records of a user completing learning objects.

        Returns:
        The call builder

      • listUserCompletions

        public LmsListUserCompletionsResponse listUserCompletions​(LmsListUserCompletionsRequest request)
        List User Completions

        Retrieve a list of completed learning records for a user.

        These are the records of a user completing learning objects.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listUserCompletions

        public LmsListUserCompletionsResponse listUserCompletions​(LmsListUserCompletionsRequest request,
                                                          java.util.Optional<Options> options)
        List User Completions

        Retrieve a list of completed learning records for a user.

        These are the records of a user completing learning objects.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createUserCompletion

        public LmsCreateUserCompletionRequestBuilder createUserCompletion()
        Create User Completion

        Create a completed learning record for a user.

        This is the record of a user completing a learning object.

        Returns:
        The call builder

      • createUserCompletion

        public LmsCreateUserCompletionResponse createUserCompletion​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            LmsCreateCompletionRequestDto lmsCreateCompletionRequestDto)
        Create User Completion

        Create a completed learning record for a user.

        This is the record of a user completing a learning object.

        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateCompletionRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createUserCompletion

        public LmsCreateUserCompletionResponse createUserCompletion​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            LmsCreateCompletionRequestDto lmsCreateCompletionRequestDto,
                                                            java.util.Optional<Options> options)
        Create User Completion

        Create a completed learning record for a user.

        This is the record of a user completing a learning object.

        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateCompletionRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getUserCompletion

        public LmsGetUserCompletionRequestBuilder getUserCompletion()
        Get User Completion

        Retrieve a completed learning record for a user by its identifier.

        This is the record of a user completing a learning object.

        Returns:
        The call builder

      • getUserCompletion

        public LmsGetUserCompletionResponse getUserCompletion​(LmsGetUserCompletionRequest request)
        Get User Completion

        Retrieve a completed learning record for a user by its identifier.

        This is the record of a user completing a learning object.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getUserCompletion

        public LmsGetUserCompletionResponse getUserCompletion​(LmsGetUserCompletionRequest request,
                                                      java.util.Optional<Options> options)
        Get User Completion

        Retrieve a completed learning record for a user by its identifier.

        This is the record of a user completing a learning object.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • deleteUserCompletion

        public LmsDeleteUserCompletionRequestBuilder deleteUserCompletion()
        Delete User Completion

        Delete a completion type learning record for a user.

        This is a record of a user completing a learning object.

        Returns:
        The call builder

      • deleteUserCompletion

        public LmsDeleteUserCompletionResponse deleteUserCompletion​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            java.lang.String subResourceId)
        Delete User Completion

        Delete a completion type learning record for a user.

        This is a record of a user completing a learning object.

        Parameters:
        xAccountId - The account identifier
        id -
        subResourceId -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • deleteUserCompletion

        public LmsDeleteUserCompletionResponse deleteUserCompletion​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            java.lang.String subResourceId,
                                                            java.util.Optional<Options> options)
        Delete User Completion

        Delete a completion type learning record for a user.

        This is a record of a user completing a learning object.

        Parameters:
        xAccountId - The account identifier
        id -
        subResourceId -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCompletions

        public LmsListCompletionsRequestBuilder listCompletions()
        List Completions

        Retrieve a list of completed learning records. These are the records of a user completing learning objects.

        Returns:
        The call builder

      • listCompletions

        public LmsListCompletionsResponse listCompletions​(LmsListCompletionsRequest request)
        List Completions

        Retrieve a list of completed learning records. These are the records of a user completing learning objects.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCompletions

        public LmsListCompletionsResponse listCompletions​(LmsListCompletionsRequest request,
                                                  java.util.Optional<Options> options)
        List Completions

        Retrieve a list of completed learning records. These are the records of a user completing learning objects.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCompletion

        public LmsGetCompletionRequestBuilder getCompletion()
        Get Completion

        Retrieve a completed learning record by its identifier. This is the record of a user completing a learning object.

        Returns:
        The call builder

      • getCompletion

        public LmsGetCompletionResponse getCompletion​(LmsGetCompletionRequest request)
        Get Completion

        Retrieve a completed learning record by its identifier. This is the record of a user completing a learning object.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCompletion

        public LmsGetCompletionResponse getCompletion​(LmsGetCompletionRequest request,
                                              java.util.Optional<Options> options)
        Get Completion

        Retrieve a completed learning record by its identifier. This is the record of a user completing a learning object.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCategory

        public LmsGetCategoryResponse getCategory​(LmsGetCategoryRequest request)
        Get Category
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCategory

        public LmsGetCategoryResponse getCategory​(LmsGetCategoryRequest request,
                                          java.util.Optional<Options> options)
        Get Category
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCategories

        public LmsListCategoriesResponse listCategories​(LmsListCategoriesRequest request)
        List Categories
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCategories

        public LmsListCategoriesResponse listCategories​(LmsListCategoriesRequest request,
                                                java.util.Optional<Options> options)
        List Categories
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listUsers

        public LmsListUsersResponse listUsers​(LmsListUsersRequest request)
        List Users
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listUsers

        public LmsListUsersResponse listUsers​(LmsListUsersRequest request,
                                      java.util.Optional<Options> options)
        List Users
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getUser

        public LmsGetUserResponse getUser​(LmsGetUserRequest request)
        Get User
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getUser

        public LmsGetUserResponse getUser​(LmsGetUserRequest request,
                                  java.util.Optional<Options> options)
        Get User
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getSkill

        public LmsGetSkillResponse getSkill​(LmsGetSkillRequest request)
        Get Skill
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getSkill

        public LmsGetSkillResponse getSkill​(LmsGetSkillRequest request,
                                    java.util.Optional<Options> options)
        Get Skill
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listSkills

        public LmsListSkillsResponse listSkills​(LmsListSkillsRequest request)
        List Skills
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listSkills

        public LmsListSkillsResponse listSkills​(LmsListSkillsRequest request,
                                        java.util.Optional<Options> options)
        List Skills
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listAssignments

        public LmsListAssignmentsRequestBuilder listAssignments()
        List Assignments

        Retrieve a list of assignment type learning records.

        These are the records linking a user to a learning object.

        They can be pending, in progress, or completed.

        Returns:
        The call builder

      • listAssignments

        public LmsListAssignmentsResponse listAssignments​(LmsListAssignmentsRequest request)
        List Assignments

        Retrieve a list of assignment type learning records.

        These are the records linking a user to a learning object.

        They can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listAssignments

        public LmsListAssignmentsResponse listAssignments​(LmsListAssignmentsRequest request,
                                                  java.util.Optional<Options> options)
        List Assignments

        Retrieve a list of assignment type learning records.

        These are the records linking a user to a learning object.

        They can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getAssignment

        public LmsGetAssignmentRequestBuilder getAssignment()
        Get Assignment

        Retrieve an assignment type learning record by its identifier.

        This is the record linking a user to a learning object.

        It can be pending, in progress, or completed.

        Returns:
        The call builder

      • getAssignment

        public LmsGetAssignmentResponse getAssignment​(LmsGetAssignmentRequest request)
        Get Assignment

        Retrieve an assignment type learning record by its identifier.

        This is the record linking a user to a learning object.

        It can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getAssignment

        public LmsGetAssignmentResponse getAssignment​(LmsGetAssignmentRequest request,
                                              java.util.Optional<Options> options)
        Get Assignment

        Retrieve an assignment type learning record by its identifier.

        This is the record linking a user to a learning object.

        It can be pending, in progress, or completed.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails