Class UserProfilesResource.GuardiansResource.GetRequest

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.
Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Guardian>
ClassroomBaseServiceRequest<Guardian>
UserProfilesResource.GuardiansResource.GetRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class GetRequest : ClassroomBaseServiceRequest<Guardian>, IClientServiceRequest<Guardian>, IClientServiceRequest

Constructors

GetRequest(IClientService, String, String)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string studentId, string guardianId)
Parameters
Type Name Description
IClientService service
System.String studentId
System.String guardianId

Properties

GuardianId

The id field from a Guardian.

Declaration
[RequestParameter("guardianId", RequestParameterType.Path)]
public virtual string GuardianId { get; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Guardian>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Guardian>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Guardian>.RestPath

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 &quot;me&quot;, indicating the requesting user
Declaration
[RequestParameter("studentId", RequestParameterType.Path)]
public virtual string StudentId { get; }
Property Value
Type Description
System.String

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Classroom.v1.ClassroomBaseServiceRequest<Google.Apis.Classroom.v1.Data.Guardian>.InitParameters()

Implements