Course Offering Details Input

Input representation of the course offering request object.

JSON example

1{
2  "courseOffering": {
3    "courseOfferingExternalId": {
4      "fieldName": "externalField__c",
5      "fieldValue": "custom field value"
6    },
7    "courseOfferingCustomAttribute": [
8      {
9        "fieldName": "customField__c",
10        "fieldValue": "custom field value"
11      }
12    ],
13    "courseOfferingId": "",
14    "courseOfferingName": "Operating System",
15    "academicSessionId": "0vcxx00000000ODAAY",
16    "learningCourseId": "0vYxx00000000ODEAY",
17    "primaryFacultyId": "003xx000004Wj36AAC",
18    "startDate": "2024-12-09T20:00:00.000Z",
19    "endDate": "2025-12-15T20:00:00.000Z",
20    "isActive": "true",
21    "enrollmentCapacity": 12,
22    "waitlistedCapacity": 2,
23    "description": "Course Offering Summer 2025 Operating System",
24    "sectionNumber": 1,
25    "courseOfferingSchedule": [
26      {
27        "courseOfferingScheduleExternalId": {
28          "fieldName": "customField__c",
29          "fieldValue": "custom field value"
30        },
31        "courseOfferingScheduleCustomAttribute": [
32          {
33            "fieldName": "customField1__c",
34            "fieldValue": "custom field value"
35          }
36        ],
37        "recurrencePattern": "RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20251130T000000Z;",
38        "startTime": "00:15:00.000",
39        "endTime": "01:15:00.000",
40        "location": "131xx0000004FoLAAU",
41        "courseOfferingScheduleTemplate": null,
42        "startDate": "2024-12-01",
43        "type": "Class",
44        "description": "LT for OS class",
45        "courseOfferingScheduleId": ""
46      },
47      {
48        "courseOfferingScheduleExternalId": {
49          "fieldName": "customField__c",
50          "fieldValue": "custom field value"
51        },
52        "courseOfferingScheduleCustomAttribute": [
53          {
54            "fieldName": "customField1__c",
55            "fieldValue": "custom field value"
56          }
57        ],
58        "recurrencePattern": "RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20251130T000000Z;",
59        "startTime": "00:15:00.000",
60        "endTime": "01:15:00.000",
61        "location": "131xx0000004FoLAAU",
62        "courseOfferingScheduleTemplate": null,
63        "startDate": "2024-12-01",
64        "type": "Class",
65        "description": " class",
66        "courseOfferingScheduleId": ""
67      }
68    ]
69  }
70}

Properties

Name	Type	Description	Required or Optional	Available Version
`academicSessionId`	String	Academic session for which course is offered.	Required	64.0
`courseOfferingCustomAttribute`	Custom Field Input[]	Custom fields associated with the course offering.	Optional	64.0
`courseOfferingExternalId`	Object	External Id details of the course offering.	Optional	64.0
`courseOfferingId`	String	ID of the course offering.	Optional	64.0
`courseOfferingName`	String	Name of the course offering.	Required	64.0
`courseOfferingSchedule`	Course Offering Schedule Input[]	Course offering schedules of a course offering.	Optional	64.0
`description`	String	Description of the course offering.	Optional	64.0
`endDate`	String	End date of the course offering.	Optional	64.0
`enrollmentCapacity`	Integer	Enrollment capacity for the course offering.	Optional	64.0
`isActive`	Boolean	Indicates whether the course offering is active (`true`) or not (`false`).	Optional	64.0
`learningCourseId`	String	Course ID for which the offering is being made.	Required	64.0
`primaryFacultyId`	String	Faculty contact ID who will be conducting the course.	Optional	64.0
`sectionNumber`	Integer	Section number of the course offering.	Optional	64.0
`startDate`	String	Start date of the course offering.	Required	64.0
`waitlistedCapacity`	Integer	Waitlist capacity of the course offering.	Optional	64.0

Education Cloud Developer Guide

Course Offering Details Input