OneRosterUserRoleOutput

Role information associated with a user

  • org
    Type: object ยท OneRosterGUIDRef
    required

    Organization associated with the role

    • 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
  • role
    Type: stringenum
    required

    Role value

    values
    • aide
    • counselor
    • districtAdministrator
    • guardian
    • parent
  • roleType
    Type: stringenum
    required

    Type of role (primary/secondary)

    values
    • primary
    • secondary
  • admissionDate
    Type: string | nullFormat: date

    Admission date for this role (transitional begin_date copy until AGREE

  • beginDate
    Type: string | null

    Date when the role assignment begins

  • endDate
    Type: string | null

    Date when the role assignment ends

  • userProfile
    Type: string | null

    User profile ID associated with this role