OneRosterUserAgentOutput

An agent relationship for a user

  • agentId
    Type: stringFormat: uuid
    required

    Unique identifier for this agent relationship. This is the same UUID used in upsertStudentAgent and deleteStudentAgent operations.

  • relationshipType
    Type: string
    required

    Type of agent relationship (e.g., parent, guardian)

  • user
    Type: object
    required

    A reference to another OneRoster entity

    • 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