Skip to main content

EventCourse

Defines the type for a course within the scope of an event.

type EventCourse {
  addAutoLoginToken: Boolean!
  backgroundColor: HexColorCode
  classifications: [CourseClassificationAssociation!]!
  confirmationMergeDocument: MergeDocument
  createdAt: DateTime!
  createdBy: String
  credits: [CourseCredit!]!
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  dateText: String
  endDate: LocalDate
  endTime: LocalTime
  externalRegistrationUrl: String
  externalWebsiteUrl: String
  feeTypes: [CourseFeeType!]!
  foodAndBeverage: String
  id: ID!
  instructors: [EventCourseInstructor!]!
  inventoryLimit: PositiveInt
  itinerary: String
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  location: Location
  masterCourseCode: String
  minimumAttendance: Int
  name: String!
  overview: String
  recordGrade: Boolean!
  recordScore: Boolean!
  roomSetup: String
  seriesCode: String
  startDate: LocalDate
  startTime: LocalTime
  status: CourseStatus!
  textColor: HexColorCode
  uniqueCode: String
}

Fields​

EventCourse.addAutoLoginToken ● Boolean! non-null scalar​

A flag indicating whether attach the contact's auto login token to the externalRegistrationUrl allowing the registration site to be pre-populated with the contacts's details.

EventCourse.backgroundColor ● HexColorCode scalar​

The hex color code to use for the background when rendering the course. Optional.

EventCourse.classifications ● [CourseClassificationAssociation!]! non-null object​

A list of course classifications associated with this course.

EventCourse.confirmationMergeDocument ● MergeDocument object​

The merge document used to confirm registration for a course. Optional.

EventCourse.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

EventCourse.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

EventCourse.credits ● [CourseCredit!]! non-null object​

A list of course credits associated with this course.

EventCourse.customFields ● [CustomField!]! non-null object​

A list of custom field values associated with this course.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
EventCourse.customFields.input ● CustomFieldSearchFilterInput! non-null input​
EventCourse.customFields.limit ● PaginationLimit! non-null scalar​
EventCourse.customFields.offset ● NonNegativeInt! non-null scalar​

EventCourse.dateText ● String scalar​

The explanatory text for the start and end of this course. Optional.

EventCourse.endDate ● LocalDate scalar​

The end date of the course. Optional.

EventCourse.endTime ● LocalTime scalar​

The session end time of the course. Optional.

EventCourse.externalRegistrationUrl ● String scalar​

The URL for an EventsAir interactive registration site for this course. Optional.

EventCourse.externalWebsiteUrl ● String scalar​

The URL for an external registration site for this course. Optional.

EventCourse.feeTypes ● [CourseFeeType!]! non-null object​

A list of fee types associated with this course.

EventCourse.foodAndBeverage ● String scalar​

Notes on required catering for the sessions of this course. Optional.

EventCourse.id ● ID! non-null scalar​

The unique identifier for the course.

EventCourse.instructors ● [EventCourseInstructor!]! non-null object​

A list of course instructors associated with this course.

EventCourse.inventoryLimit ● PositiveInt scalar​

The inventory limit for this course. Optional.

EventCourse.itinerary ● String scalar​

The itinerary for this course. Optional.

EventCourse.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

EventCourse.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

EventCourse.location ● Location object​

The location of this course. Optional.

EventCourse.masterCourseCode ● String scalar​

The course unique code on which this course is based. Optional.

EventCourse.minimumAttendance ● Int scalar​

The minimum attendance allowed for this course. Optional.

EventCourse.name ● String! non-null scalar​

A UTF-8 string representing the name of the course.

EventCourse.overview ● String scalar​

The overview for this course. Optional.

EventCourse.recordGrade ● Boolean! non-null scalar​

A flag indicating whether grade will be recorded for course attendees.

EventCourse.recordScore ● Boolean! non-null scalar​

A flag indicating whether score will be recorded for course attendees.

EventCourse.roomSetup ● String scalar​

Notes about how the session room should be configured for this course. Optional.

EventCourse.seriesCode ● String scalar​

The series code for this course. Optional.

EventCourse.startDate ● LocalDate scalar​

The start date of the course. Optional.

EventCourse.startTime ● LocalTime scalar​

The session start time of the course. Optional.

EventCourse.status ● CourseStatus! non-null enum​

The status of this course.

EventCourse.textColor ● HexColorCode scalar​

The hex color code to use when rendering the course's text. Optional.

EventCourse.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the course. Optional.

The value must be unique across all courses for an event.

Member Of​

CreateEventCoursePayload object ● EventCourseRegistration object ● EventCourseSetup object ● UpdateEventCoursePayload object