Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Students

Package version

Interface representing a Students.

Hierarchy

  • Students

Implemented by

Index

Methods

Methods

createOrUpdate

  • Create and add a new student to the specified lab or update the details of an existing student in a lab. Note the student must have a valid tenant to accept the lab after they have been added to lab.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • studentAlias: string

      Student alias.

    • parameters: StudentDetails

      Request parameters that are provided to update student properties.

    • Optional options: StudentsCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<StudentsCreateOrUpdateResponse>

delete

  • delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsDeleteOptionalParams): Promise<void>

  • Delete the specified student based on the student alias.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • studentAlias: string

      Student alias.

    • Optional options: StudentsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • Get the details for a specific student in the specified lab by student alias

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • studentAlias: string

      Student alias.

    • Optional options: StudentsGetOptionalParams

      The options parameters.

    Returns Promise<StudentsGetResponse>

list

  • Get a list of details about students that are associated with the specified lab.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • Optional options: StudentsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<StudentDetails>

Generated using TypeDoc