OneRosterEnrollmentOutput

  • class
    Type: object · OneRosterGUIDRef
    required

    A reference to another OneRoster entity

    • href
      Type: string Format: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: string enum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • dateLastModified
    Type: string Format: date-time
    required

    Timestamp of when the enrollment was last modified

  • primary
    Type: boolean
    required

    Whether this is the primary enrollment

  • role
    Type: string
    required

    Role of the user in this enrollment

  • school
    Type: object · OneRosterGUIDRef
    required

    A reference to another OneRoster entity

    • href
      Type: string Format: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: string enum
      required

      Type of the referenced entity

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

    Unique identifier for the enrollment

  • status
    Type: string
    required

    Current status of the enrollment

  • user
    Type: object · OneRosterGUIDRef
    required

    A reference to another OneRoster entity

    • href
      Type: string Format: uri
      required

      URI reference to the entity

    • sourcedId
      Type: string
      required

      Unique identifier of the referenced entity

    • type
      Type: string enum
      required

      Type of the referenced entity

      values
      • academicSession
      • category
      • class
      • course
      • demographics
  • beginDate
    Type: string Format: date

    Start date of the enrollment

  • endDate
    Type: string Format: date

    End date of the enrollment

  • metadata
    Type: object

    Additional metadata associated with the enrollment

    • propertyName
      Type: anything