get method

Future<GuardianInvitation> get(
  1. String studentId,
  2. String invitationId, {
  3. String? $fields,
})

Returns a specific guardian invitation.

This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view guardian invitations for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). * NOT_FOUND if Classroom cannot find any record of the given student or invitation_id. May also be returned if the student exists, but the requesting user does not have access to see that student.

Request parameters:

studentId - The ID of the student whose guardian invitation is being requested.

invitationId - The id field of the GuardianInvitation being requested.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GuardianInvitation.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GuardianInvitation> get(
  core.String studentId,
  core.String invitationId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/userProfiles/' +
      commons.escapeVariable('$studentId') +
      '/guardianInvitations/' +
      commons.escapeVariable('$invitationId');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GuardianInvitation.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}