OneRosterCourseBaseInput

  • courseCode
    Type: string
    required

    Code used to identify the course

  • org
    Type: object · OneRosterGUIDRef
    required

    Organization the course belongs to (required for API endpoints)

    • href
      Type: stringFormat: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: stringenum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • sourcedId
    Type: string
    required

    Unique identifier for the course

  • status
    Type: string · EntityStatusenum
    required

    Status of an entity in the system

    values
    • active
    • tobedeleted
    • inactive
  • title
    Type: string
    required

    Title of the course

  • grades
    Type: array string[] | null

    Array of grade levels associated with the course

  • metadata
    Type: object | null

    Additional metadata associated with the course

    • propertyName
      Type: anything
  • schoolYear
    Type: object · OneRosterGUIDRef nullable

    Academic session (school year) information

    • href
      Type: stringFormat: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: stringenum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • subjectCodes
    Type: array string[] | null

    Array of subject codes for the course

  • subjects
    Type: array string[] | null

    Array of subjects covered in the course