GET api/{version}/StudentCourseMaterial/GetDocumentMaterial?studentCourseMaterialId={studentCourseMaterialId}&registrationId={registrationId}&divisionId={divisionId}

Used to get the course material details for document material tyep

Request Information

URI Parameters

Name	Type	Additional information
studentCourseMaterialId	integer	Required
registrationId	integer	Required
divisionId	integer	Required
version	string	None.

Body Parameters

None.

Response Information

Resource Description

StudentCourseMaterialDetail

Name	Description	Type	Additional information
StudentCourseMaterialId	Gets or sets the Primary Key value	integer	None.
CourseMaterialFolderId	Gets or sets the course material folder	integer	None.
InstructorId	Gets or sets the instructor Id	integer	None.
AllowQuestionToInstructor	Gets or sets allow Question To Instructor	boolean	None.
MaterialId	Gets or sets the Material Id	integer	None.
MaterialDescription	Gets or sets the Description of material	string	None.
Progress	Gets or sets the Progress of material	decimal number	None.
NextMaterialId	Gets or sets the Next material id based on sequence	integer	None.
PreviousMaterialId	Gets or sets the Previous material id based on sequence	integer	None.
MaterialType	Gets or sets the Material Type(like Video, Notes or Practice portal)	string	None.
AvailableFrom	Gets or sets the Available From Date	date	None.
AvailableTo	Gets or sets the Available To Date	date	None.
IsTrackProgress	Gets or sets the Tracked or Not	boolean	None.
PaymentUrl	Gets or sets PaymentUrl	string	None.
IsNeedPayment	Gets or sets the Payment Needed or not	boolean	None.
IsPreview	Gets or sets the Preview Available or not	boolean	None.
CompletedStatus	Gets or sets the Status of the Material	boolean	None.
RegistrationId	Gets or sets the student registration Id	integer	None.
IsPreviewRegistration	Gets or sets the preview registrations	boolean	None.
IsSubscriptionCenter	Gets or sets the subscription center	boolean	None.
LastWatchedInterval	Gets or sets the last watched interval of material	integer	None.
LastVisitedOn	Gets or sets the last visited on	date	None.
LastVisitedPage	Gets or sets te last visited page	integer	None.
MaterialProgress	Gets or sets the material progress percentage	decimal number	None.
HasNotes	Gets or sets the note details	boolean	None.
IsBookMarked	Gets or sets the book mark status	boolean	None.
IsEligibleForSubExtension	Gets or sets the is eligible for extensions	boolean	None.
StudentProductId	Gets or sets the student product ids	integer	None.
MaterialAccess	Gets or sets the material access	boolean	None.
WaterMarkInfo	Gets or sets the water mark info	WaterMark	None.
CompanyName	Gets or sets company name	string	None.
VideoMaterialDetail	Gets or sets the video material details	VideoMaterialDetail	None.
DocumentMaterialDetail	Gets or sets the document material object	DocumentMaterialDetail	None.
PracticePortalMaterialDetail	Gets or sets the practice portal material details	PracticePortalMaterialDetail	None.
FlashcardSetDetail	Get or set the flash card set details	FlashcardSet	None.
ReturnUrl	Gets or sets ReturnUrl	string	None.
ConstantValue	Gets or sets ConstantValue	string	None.
SubjectType		string	None.
lstStudentCourseMaterials		Collection of StudentCourseMaterials	None.
MobileAppResponseMessage		string	None.
QandATopicId		string	None.
MaterialTypeGroup		string	None.
EnableFreeTrial		boolean	None.
IsHavingFreeTrialAccess		boolean	None.
StudyHubDomain		string	None.

Response Formats

application/json, text/json

Sample:

{
  "StudentCourseMaterialId": 1,
  "CourseMaterialFolderId": 2,
  "InstructorId": 3,
  "AllowQuestionToInstructor": true,
  "MaterialId": 5,
  "MaterialDescription": "sample string 6",
  "Progress": 7.0,
  "NextMaterialId": 8,
  "PreviousMaterialId": 9,
  "MaterialType": "sample string 10",
  "AvailableFrom": "2026-04-02T23:47:22.4108701-04:00",
  "AvailableTo": "2026-04-02T23:47:22.4108701-04:00",
  "IsTrackProgress": true,
  "PaymentUrl": "sample string 14",
  "IsNeedPayment": true,
  "IsPreview": true,
  "CompletedStatus": true,
  "RegistrationId": 18,
  "IsPreviewRegistration": true,
  "IsSubscriptionCenter": true,
  "LastWatchedInterval": 21,
  "LastVisitedOn": "2026-04-02T23:47:22.4108701-04:00",
  "LastVisitedPage": 23,
  "MaterialProgress": 24.1,
  "HasNotes": true,
  "IsBookMarked": true,
  "IsEligibleForSubExtension": true,
  "StudentProductId": 28,
  "MaterialAccess": true,
  "WaterMarkInfo": {
    "WatermarkText": "sample string 1",
    "WaterMarkId": 2,
    "Fontsize": 3,
    "FontOpacity": 4,
    "isDefaultWaterMark": true,
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "EmailAddress": "sample string 8"
  },
  "CompanyName": "sample string 30",
  "VideoMaterialDetail": {
    "VideoId": 1,
    "Duration": 2,
    "Notes": [
      {
        "VideoNoteId": 1,
        "Comments": "sample string 2",
        "VideoId": "sample string 3",
        "RegistrationId": 4,
        "VideoPlayerId": 5,
        "NoteInterval": 6,
        "NoteIntervalDuration": "sample string 7",
        "VideoSourceId": 8,
        "VideoSourceTable": "sample string 9"
      },
      {
        "VideoNoteId": 1,
        "Comments": "sample string 2",
        "VideoId": "sample string 3",
        "RegistrationId": 4,
        "VideoPlayerId": 5,
        "NoteInterval": 6,
        "NoteIntervalDuration": "sample string 7",
        "VideoSourceId": 8,
        "VideoSourceTable": "sample string 9"
      }
    ],
    "VideoUrl": "sample string 3",
    "MaterialId": 4,
    "IsBookMarked": true,
    "LasWatchedDuration": 6,
    "VideoProgressLogId": 7,
    "PreviewVideoSettingValue": 8,
    "ListVideoRefVideoService": [
      {
        "VideoRefVideoServiceID": 1,
        "VideoID": 2,
        "VideoServiceID": 3,
        "VideoPlayerRefId": "sample string 4",
        "ServiceVideoRefId": "sample string 5",
        "VideoStatusID": 6,
        "VideoServiceName": "sample string 7",
        "VideoHubStatus": "sample string 8",
        "DynamicClass": "sample string 9",
        "DynamicSymbolClass": "sample string 10",
        "DynamicServerMessage": "sample string 11",
        "ShortCode": "sample string 12",
        "VideoUrl": "sample string 13",
        "VideoEmbedCode": "sample string 14",
        "CreatedOn": "2026-04-02T23:47:22.4108701-04:00",
        "CreatedBy": "sample string 16",
        "VideoPlayerId": 17,
        "SecurityToken": "sample string 18",
        "IsPublished": true,
        "VideoStatusMessage": "sample string 20",
        "HasAnyUnPublishedVideo": true,
        "UnPublishedVideoStatusMessage": "sample string 22",
        "MaxVideoDuration": 23
      },
      {
        "VideoRefVideoServiceID": 1,
        "VideoID": 2,
        "VideoServiceID": 3,
        "VideoPlayerRefId": "sample string 4",
        "ServiceVideoRefId": "sample string 5",
        "VideoStatusID": 6,
        "VideoServiceName": "sample string 7",
        "VideoHubStatus": "sample string 8",
        "DynamicClass": "sample string 9",
        "DynamicSymbolClass": "sample string 10",
        "DynamicServerMessage": "sample string 11",
        "ShortCode": "sample string 12",
        "VideoUrl": "sample string 13",
        "VideoEmbedCode": "sample string 14",
        "CreatedOn": "2026-04-02T23:47:22.4108701-04:00",
        "CreatedBy": "sample string 16",
        "VideoPlayerId": 17,
        "SecurityToken": "sample string 18",
        "IsPublished": true,
        "VideoStatusMessage": "sample string 20",
        "HasAnyUnPublishedVideo": true,
        "UnPublishedVideoStatusMessage": "sample string 22",
        "MaxVideoDuration": 23
      }
    ],
    "DefaultVideoPlayerCode": "sample string 9",
    "VzaarVideo": {
      "EnableVzaarPlayer": true,
      "VzaarVideoUrl": "sample string 2",
      "VzaarVideoId": "sample string 3"
    },
    "EnableFreeTrial": true
  },
  "DocumentMaterialDetail": {
    "Duration": 1,
    "DocumentUrl": "sample string 2",
    "DownloadUrl": "sample string 3",
    "MaterialId": 4,
    "LicenseKey": "sample string 5",
    "StudentDocumentsTrackId": 6,
    "LastVisitedPageNumber": 7,
    "Annotations": "sample string 8",
    "LastWatchedDuration": 9,
    "IsAllowDownload": true,
    "CourseMaterialReferenceId": 11,
    "PreviewDocumentSettingValue": 12
  },
  "PracticePortalMaterialDetail": {
    "TestId": 1,
    "TestTypeCode": "sample string 2",
    "TestGroupId": 3,
    "PracticeUserId": 4,
    "TestUrl": "sample string 5",
    "testAttempts": [
      {},
      {}
    ],
    "CompletedStatus": true
  },
  "FlashcardSetDetail": {
    "FlashcardSetAttemptsId": 1,
    "FlashcardSetId": 2,
    "FlashcardSetName": "sample string 3",
    "LtFlashcard": [
      {
        "FlashcardAttemptDetailsId": 1,
        "FlashcardId": 2,
        "CardNo": "sample string 3",
        "FrontText": "sample string 4",
        "BackText": "sample string 5",
        "OrderSequence": 6,
        "IsHtmlContent": true,
        "IsCurrentCard": true,
        "IsFrontViewed": true,
        "IsBackViewed": true,
        "Comment": "sample string 11",
        "Rating": 12,
        "Notes": "sample string 13",
        "IsCompleted": true,
        "IsBookMarked": true,
        "Version": "sample string 16"
      },
      {
        "FlashcardAttemptDetailsId": 1,
        "FlashcardId": 2,
        "CardNo": "sample string 3",
        "FrontText": "sample string 4",
        "BackText": "sample string 5",
        "OrderSequence": 6,
        "IsHtmlContent": true,
        "IsCurrentCard": true,
        "IsFrontViewed": true,
        "IsBackViewed": true,
        "Comment": "sample string 11",
        "Rating": 12,
        "Notes": "sample string 13",
        "IsCompleted": true,
        "IsBookMarked": true,
        "Version": "sample string 16"
      }
    ],
    "IsShuffle": true,
    "StartedOn": "2026-04-02T23:47:22.4108701-04:00",
    "IsCompleted": true,
    "PreviewFlashCardSettingValue": 7,
    "FlashCardApiRatingUrl": "sample string 8",
    "FlashCardApiFeedBackUrl": "sample string 9",
    "tokenkey": "sample string 10",
    "userid": "sample string 11"
  },
  "ReturnUrl": "sample string 31",
  "ConstantValue": "sample string 32",
  "SubjectType": "sample string 33",
  "lstStudentCourseMaterials": [
    {
      "StudentCourseMaterialId": 1,
      "RegistrationId": 2,
      "IsPreviewRegistration": true,
      "IsPreview": true,
      "IsSubscriptionCenter": true,
      "CourseMaterialId": 6,
      "CourseMaterialFolderId": 7,
      "AvailableFrom": "2026-04-02T23:47:22.4108701-04:00",
      "AvailableTo": "2026-04-02T23:47:22.4108701-04:00",
      "VisibleToStudent": true,
      "LastWatchedInterval": 11,
      "LastVisitedOn": "2026-04-02T23:47:22.4108701-04:00",
      "LastVisitedPage": 13,
      "MaterialProgress": 14.1,
      "HasNotes": true,
      "IsBookMarked": true,
      "MaterialType": "sample string 17",
      "MaterialSequence": 18,
      "MaterialTypeInfo": {
        "CourseMaterialTypeId": 1,
        "ShortCode": "sample string 2",
        "GroupCode": "sample string 3",
        "Description": "sample string 4",
        "CssIconClass": "sample string 5",
        "IsEnabled": true,
        "EnableAllowDownload": true,
        "EnableAddWaterMark": true,
        "EnableNeedPayment": true,
        "EnablePreview": true,
        "EnableTrackProgress": true,
        "EnableAccessDuration": true,
        "EnableTimeDuration": true,
        "EnableStudentVisibility": true,
        "MaterialTypeName": "sample string 15"
      },
      "FolderInfo": {
        "CourseMaterialFolderId": 1,
        "EncrytedCourseMaterialFolderId": "sample string 2",
        "PeriodId": 3,
        "CourseId": 4,
        "CenterId": 5,
        "SubjectId": 6,
        "FolderName": "sample string 7",
        "ParentCourseMaterialFolderId": 8,
        "CreatedOn": "2026-04-02T23:47:22.4108701-04:00",
        "Sequence": 10,
        "TopicLevel": 11,
        "FolderProgress": 12.0
      },
      "MaterialInfo": {
        "CourseMaterialId": 1,
        "CourseMaterialFolderId": 2,
        "ShortCode": "sample string 3",
        "Description": "sample string 4",
        "MaterialSequence": 5,
        "TestGroupId": 6,
        "PracticePortalTestId": 7,
        "VideoId": "sample string 8",
        "FileId": "sample string 9",
        "CourseMaterialReferenceId": 10,
        "ItemIndex": 11,
        "Duration": 12,
        "AllowDownload": true,
        "MaterialAccess": true,
        "lastVisitedMaterialId": 15,
        "TrackProgress": true,
        "MaterialLevel": 17,
        "WaterMarkTextId": 18,
        "QuestionBankDirectories": [
          {
            "QuestionBankDirectoryId": 1,
            "MaterialId": 2,
            "DirectoryId": 3
          },
          {
            "QuestionBankDirectoryId": 1,
            "MaterialId": 2,
            "DirectoryId": 3
          }
        ],
        "OfflineAllowDownload": true
      },
      "TrackProgress": true,
      "IsFolderTrackProgress": true,
      "ParentStudentCourseMaterialId": 21
    },
    {
      "StudentCourseMaterialId": 1,
      "RegistrationId": 2,
      "IsPreviewRegistration": true,
      "IsPreview": true,
      "IsSubscriptionCenter": true,
      "CourseMaterialId": 6,
      "CourseMaterialFolderId": 7,
      "AvailableFrom": "2026-04-02T23:47:22.4108701-04:00",
      "AvailableTo": "2026-04-02T23:47:22.4108701-04:00",
      "VisibleToStudent": true,
      "LastWatchedInterval": 11,
      "LastVisitedOn": "2026-04-02T23:47:22.4108701-04:00",
      "LastVisitedPage": 13,
      "MaterialProgress": 14.1,
      "HasNotes": true,
      "IsBookMarked": true,
      "MaterialType": "sample string 17",
      "MaterialSequence": 18,
      "MaterialTypeInfo": {
        "CourseMaterialTypeId": 1,
        "ShortCode": "sample string 2",
        "GroupCode": "sample string 3",
        "Description": "sample string 4",
        "CssIconClass": "sample string 5",
        "IsEnabled": true,
        "EnableAllowDownload": true,
        "EnableAddWaterMark": true,
        "EnableNeedPayment": true,
        "EnablePreview": true,
        "EnableTrackProgress": true,
        "EnableAccessDuration": true,
        "EnableTimeDuration": true,
        "EnableStudentVisibility": true,
        "MaterialTypeName": "sample string 15"
      },
      "FolderInfo": {
        "CourseMaterialFolderId": 1,
        "EncrytedCourseMaterialFolderId": "sample string 2",
        "PeriodId": 3,
        "CourseId": 4,
        "CenterId": 5,
        "SubjectId": 6,
        "FolderName": "sample string 7",
        "ParentCourseMaterialFolderId": 8,
        "CreatedOn": "2026-04-02T23:47:22.4108701-04:00",
        "Sequence": 10,
        "TopicLevel": 11,
        "FolderProgress": 12.0
      },
      "MaterialInfo": {
        "CourseMaterialId": 1,
        "CourseMaterialFolderId": 2,
        "ShortCode": "sample string 3",
        "Description": "sample string 4",
        "MaterialSequence": 5,
        "TestGroupId": 6,
        "PracticePortalTestId": 7,
        "VideoId": "sample string 8",
        "FileId": "sample string 9",
        "CourseMaterialReferenceId": 10,
        "ItemIndex": 11,
        "Duration": 12,
        "AllowDownload": true,
        "MaterialAccess": true,
        "lastVisitedMaterialId": 15,
        "TrackProgress": true,
        "MaterialLevel": 17,
        "WaterMarkTextId": 18,
        "QuestionBankDirectories": [
          {
            "QuestionBankDirectoryId": 1,
            "MaterialId": 2,
            "DirectoryId": 3
          },
          {
            "QuestionBankDirectoryId": 1,
            "MaterialId": 2,
            "DirectoryId": 3
          }
        ],
        "OfflineAllowDownload": true
      },
      "TrackProgress": true,
      "IsFolderTrackProgress": true,
      "ParentStudentCourseMaterialId": 21
    }
  ],
  "MobileAppResponseMessage": "sample string 34",
  "QandATopicId": "sample string 35",
  "MaterialTypeGroup": "sample string 36",
  "EnableFreeTrial": true,
  "IsHavingFreeTrialAccess": true,
  "StudyHubDomain": "sample string 39"
}