GET api/{version}/StudentCourseStudyPlan/GetStudentStudyPlanScheduleDetails?registrationId={registrationId}

Used to hold study plan schedule, block out dates and other configuration of study plan

Request Information

URI Parameters

NameDescriptionTypeAdditional information
registrationId

integer

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

StudentStudyPlanScheduleDetails
NameDescriptionTypeAdditional information
StudyPlanSchedulesWithSeparator

Used to pass the schedule as a string

string

None.

StudentStudyPlanConfigurationInfo

Gets or sets the start date, end date, review date and other common configurations

StudentStudyPlanConfiguration

None.

StudentStudyPlanScheduleInfo

Gets or sets the schedule week day

Collection of StudentStudyPlanSchedules

None.

StudentBlockoutDaysInfo

Gets or sets the block out days

Collection of StudentBlockoutDays

None.

ShowAvailableHours

boolean

None.

IsEditStudyPlan

boolean

None.

StudentStudyPlanHoursInfo

StudentStudyPlanHours

None.

Response Formats

application/json, text/json

Sample:
{
  "StudyPlanSchedulesWithSeparator": "sample string 1",
  "StudentStudyPlanConfigurationInfo": {
    "StudentStudyPlanConfigurationId": 1,
    "RegistrationId": 2,
    "StudyPlanRemainderDate": "2026-04-02T23:52:00.3607754-04:00",
    "IsRevisionRequired": true,
    "IsPlanCreated": true,
    "CurrentTab": "sample string 6",
    "StudyPlanStartDate": "2026-04-02T23:52:00.3607754-04:00",
    "DefaultStudyPlanStartDate": "2026-04-02T23:52:00.3607754-04:00",
    "ExamDate": "2026-04-02T23:52:00.3607754-04:00",
    "ReviewDate": "2026-04-02T23:52:00.3607754-04:00",
    "TotalHoursRequired": 9.1,
    "TotalAvailableHours": 10.1,
    "TotalRevisionHoursRequired": 11.1,
    "StudentProductId": 12,
    "RegistrationDate": "2026-04-02T23:52:00.3607754-04:00",
    "ActivatedDate": "2026-04-02T23:52:00.3607754-04:00",
    "weekDayHours": [
      {
        "Text": "sample string 1",
        "Value": "sample string 2",
        "Selected": true,
        "Url": "sample string 4"
      },
      {
        "Text": "sample string 1",
        "Value": "sample string 2",
        "Selected": true,
        "Url": "sample string 4"
      }
    ],
    "IsStudentRevision": true,
    "TotalSubjectHours": 16.1,
    "StudyPlanActualSubjectHours": 17.1,
    "StudyPlanCompletedSubjectHours": 18.1,
    "IsVariableExamType": true,
    "RevisionHoursForEachTopic": 20,
    "IsCBTExamType": true,
    "CourseAccessEndDate": "2026-04-02T23:52:00.3607754-04:00",
    "IncludeOnlineOnsiteCenter": true,
    "ShowIncludeOnlineOnsiteCenter": true,
    "TotalHoursRequiredWithSchedule": 24.1,
    "TotalHoursRequiredWithOutSchedule": 25.1,
    "IsComboOnline": true,
    "IsEditInProgress": true
  },
  "StudentStudyPlanScheduleInfo": [
    {
      "StudentStudyPlanScheduleId": 1,
      "RegistrationId": 2,
      "ScheduledDay": 3,
      "ScheduledHours": 4.0
    },
    {
      "StudentStudyPlanScheduleId": 1,
      "RegistrationId": 2,
      "ScheduledDay": 3,
      "ScheduledHours": 4.0
    }
  ],
  "StudentBlockoutDaysInfo": [
    {
      "StudentBlockoutDayId": 1,
      "RegistrationId": 2,
      "StartDate": "2026-04-02T23:52:00.3607754-04:00",
      "EndDate": "2026-04-02T23:52:00.3607754-04:00",
      "IsRemoved": true
    },
    {
      "StudentBlockoutDayId": 1,
      "RegistrationId": 2,
      "StartDate": "2026-04-02T23:52:00.3607754-04:00",
      "EndDate": "2026-04-02T23:52:00.3607754-04:00",
      "IsRemoved": true
    }
  ],
  "ShowAvailableHours": true,
  "IsEditStudyPlan": true,
  "StudentStudyPlanHoursInfo": {
    "AvailableHours": 1.1,
    "RequiredHours": 2.1,
    "IsRevisionRequired": true,
    "RevisionCount": 4,
    "TotalSubjectHours": 5.1,
    "TotalRevisionHours": 6.1,
    "IsChangehoursRequired": true,
    "IsEditStudyPlan": true
  }
}