get method

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

Returns a specific guardian.

This method returns the following error codes: * PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to view guardian information 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 the requesting user is permitted to view guardians for the requested student_id, but no Guardian record exists for that student that matches the provided guardian_id.

Request parameters:

studentId - The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

guardianId - The id field from a Guardian.

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

Completes with a Guardian.

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<Guardian> get(
  core.String studentId,
  core.String guardianId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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